Giter VIP home page Giter VIP logo

aws-s3-client's Introduction

aws-s3-client

This is an extraction of the S3 client files from aws-sdk node package

Objective

The goal here is to have a smaller package (in bytes) that contains only the files necessary to interact with AWS S3 in a way so a zipped version of the application is smaller than 5MB and we are able to see our code when deployed to lambda function using custom layers

Justification

  • In order for you to be able to see your code on the AWS Lambda Function console your zip deployed package has to be not larger than 5MB
  • If we use a custom layer for a version of the nodejs that is newer than the ones provided by AWS the aws-sdk package is not provided
  • So, when using a custom layer, we need to install the aws-sdk library to interact with S3 with our lambda function
  • When we install the aws-sdk package our zip-file gets larger than 5MB, which takes from us the ability to see our code on the AWS Lambda Function console, and we don't want that

Instalation

npm install --save @everymundo/aws-s3-client

Usage

Using Async functions your code can be as simple as this:

// We recommend you using the following approach just so you can easily stub ```lib.S3``` on your tests
const lib = require('@everymundo/aws-s3-client')

const getS3File = async (Bucket, Key) => {
  const s3client = new lib.S3()

  return s3client.getObject({Bucket, Key}).promise()
})

If you prefer the callback approach you can do this:

// We recommend you using the following approach just so you can easily stub ```lib.S3``` on your tests
const lib = require('@everymundo/aws-s3-client')

const getS3File = (Bucket, Key) => new Promise((resolve, reject) => {
  const s3client = new lib.S3()

  s3client.getObject({Bucket, Key}, (err, response) => err ? reject(err) : resolve(response))
})

if you don't care for stubbing you can go ahead and import the S3 directly as a constant

const {S3} = require('@everymundo/aws-s3-client')

aws-s3-client's People

Contributors

danielsanem avatar danielsan avatar

Watchers

 avatar James Cloos avatar  avatar  avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.