{"_id":"@astronomer/emitter-s3","_rev":"11-42fa76af7bb827cbfbaa5d8054c6df55","name":"@astronomer/emitter-s3","description":"Emits an array of JSON object to an Amazon S3 file.","dist-tags":{"latest":"3.0.0"},"versions":{"2.0.0":{"name":"@astronomer/emitter-s3","version":"2.0.0","description":"Emits an array of JSON object to an Amazon S3 file.","main":"lib/index.js","scripts":{"test":"mocha test/test.js","test-watch":"mocha -w test/test.js"},"author":{"name":"Alois Barreras"},"license":"MIT","dependencies":{"@astronomerio/astronomer-logger":"^1.1.3","aws-sdk":"^2.4.14","highland":"^2.10.5","thenify":"^3.2.0"},"devDependencies":{"chai":"^3.5.0","mocha":"^3.0.2","sinon":"^1.17.6"},"gitHead":"2353b3bae495694a42befa46395379090b469d7b","_id":"@astronomer/emitter-s3@2.0.0","_shasum":"0940f10ff6e5130ac2451cf4fa6923bd777acdd6","_from":".","_npmVersion":"4.2.0","_nodeVersion":"7.9.0","_npmUser":{"name":"aloisatastronomer","email":"alois@astronomer.io"},"dist":{"shasum":"0940f10ff6e5130ac2451cf4fa6923bd777acdd6","tarball":"https://registry.npmjs.org/@astronomer/emitter-s3/-/emitter-s3-2.0.0.tgz","integrity":"sha512-WYHY5hIFGAQU+D+/uawWzCkLksICrDBrICf7FsrfKftJTwJaKG+sdUaZRi417GmlkVlMwQ76z+mcYHdElu/MvQ==","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEYCIQCbn+F2dWd4XzJuPj1inFSO3DSzR67Qc8tRudTjRVQhxgIhAMgtY0ILrAz1WwTl9j3ESCCSBTB4IaRblLeTIRBwJU4Y"}]},"maintainers":[{"name":"aloisatastronomer","email":"alois@astronomer.io"}],"_npmOperationalInternal":{"host":"packages-12-west.internal.npmjs.com","tmp":"tmp/emitter-s3-2.0.0.tgz_1493131316682_0.8328847540542483"},"directories":{}},"3.0.0":{"name":"@astronomer/emitter-s3","version":"3.0.0","description":"Emits an array of JSON object to an Amazon S3 file.","main":"lib/index.js","scripts":{"test":"mocha test/test.js","test-watch":"mocha -w test/test.js"},"author":{"name":"Alois Barreras"},"license":"MIT","dependencies":{"aws-sdk":"^2.4.14","highland":"^2.10.5"},"devDependencies":{"chai":"^4.0.2","eslint":"^3.19.0","eslint-config-airbnb":"^15.0.1","eslint-plugin-import":"^2.3.0","eslint-plugin-jsx-a11y":"^5.0.3","eslint-plugin-react":"^7.0.1","mocha":"^3.4.2","sinon":"^2.3.2"},"gitHead":"36af65c7a08c3a190eee331359e5ebe4ef95481a","_id":"@astronomer/emitter-s3@3.0.0","_npmVersion":"5.0.3","_nodeVersion":"8.0.0","_npmUser":{"name":"aloisatastronomer","email":"alois@astronomer.io"},"dist":{"integrity":"sha512-gNScHzbZGD2lYgS9i3G2R5VwUcyL7pc44hrnln2RV1FV16WH4J+k0TIXK6RejB9B9N9LcoMA7bziCk5kJNXDMg==","shasum":"602a59f2d42cc7cbf8c300cddc762eb27eef3d33","tarball":"https://registry.npmjs.org/@astronomer/emitter-s3/-/emitter-s3-3.0.0.tgz","signatures":[{"keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA","sig":"MEQCID7KFMWL40ZOJhtAncRsai9QlAd5rH1oYThqQmkE0vIMAiAno1dSZ04bkXtc4UCo0HFIdtqfR2PdbUpEMCZAp8YIfw=="}]},"maintainers":[{"name":"aloisatastronomer","email":"alois@astronomer.io"},{"name":"gregatastronomer","email":"greg@astronomer.io"},{"name":"mikeperry","email":"mike@astronomer.io"}],"_npmOperationalInternal":{"host":"s3://npm-registry-packages","tmp":"tmp/emitter-s3-3.0.0.tgz_1496775821529_0.7815681144129485"},"directories":{}}},"readme":"[![CircleCI](https://circleci.com/gh/astronomerio/emitter-s3.svg?style=svg)](https://circleci.com/gh/astronomerio/emitter-s3)\n\n# emitter-s3\n\nWrapper for the AWS.S3 client that will emit an array or stream of JSON object to an s3 file.\n\n## Creating an Emitter\n\nImport the S3Emitter from 'emitter-s3' and pass in an options object to the constructor.\n\n```javascript\nimport S3Emitter from 'emitter-s3';\n\nconst options = {\n    filePath: 'my/file/path',\n    bucketName: 'my_bucket',\n    region: 'us-east-1',\n    awsAccessKeyId: 'accessKeyId',\n    awsSecretAccessKey: 'secretAccessKey'\n};\n\nconst emitter = new S3Emitter(options);\n```\n\n## Options\n\n### filePath (optional)\n\nThe file path at which your s3 files will be stored.\n\n### appendTimestampToFilename\n\nDefault: true\n\nBy default, this will make the filename an ISO formatted date string. You can use filePath to create a path prefix with the filename as the timestamp.\n\n### bucketName\n\nThe name of your S3 bucket.\n\n### region\n\nThe region in which your S3 bucket is.\n\n### serverSideEncryption (optional)\n\nAWS S3 supports [server side encryption](http://docs.aws.amazon.com/AmazonS3/latest/dev/UsingServerSideEncryption.html). If your bucket policy requires the server side encryption header to be set, you can specify that here.\n\nPossible values are 'AES256' or 'aws:kms'.\n\n## API\n\n### .emit(records)\n\nEmits the data to an s3 file. Returns a promise.\n\n```javascript\n// using babel\nawait emitter.emit(data);\n\n// or with promises\nemitter.emit(data).then(function () {\n    // do something after uploading file\n});\n```\n\n## License\n\nReleased under the MIT License.\n","maintainers":[{"email":"ryan@ryanahamilton.com","name":"ryanahamilton"},{"email":"sam@sam.black","name":"samblackk"},{"email":"greg@astronomer.io","name":"gregatastronomer"}],"time":{"modified":"2022-06-12T14:49:34.594Z","created":"2017-04-25T14:41:56.934Z","2.0.0":"2017-04-25T14:41:56.934Z","3.0.0":"2017-06-06T19:03:41.622Z"},"author":{"name":"Alois Barreras"},"license":"MIT","readmeFilename":"README.md"}