Nepotistic Pontifex Maximus

    lambda-service-client
    TypeScript icon, indicating that this package has built-in type declarations

    2.0.0 • Public • Published

    lambda-service-client

    ci_on_commit deploy_on_tag

    A simple, convenient way to invoke aws lambda functions with best practices.

    Best practices:

    • optional logDebug of input and output
    • throw an error if response contains an error object

    Install

    npm install --save lambda-service-client

    Example

    import { createLambdaServiceClient } from 'lambda-service-client';
     
    const invokeLambdaFunction = createLambdaServiceClient({ serviceName: 'svc-jobs', stage });
     
    export const getJobByUuid = (event: { uuid: string }): Promise<{ job: Job | null }> => invokeLambdaFunction({ functionName: 'getJobByUuid', event });

    Usage

    invoke

    create a function to invoke your lambda with the createLambdaServiceClient method

    import { createLambdaServiceClient } from 'lambda-service-client';
     
    const invokeLambdaFunction = createLambdaServiceClient({ serviceName: 'svc-jobs', stage });

    which you can use directly:

    const result = await invokeLambdaFunction({ functionName, event: testPayload });
    // ...do amazing things with result...

    type

    but you'll probably want to add some typedefs and name it for readability:

    export const getJobByUuid = (event: { uuid: string }) => invokeLambdaFunction<{ job: Job | null }>({ functionName: 'getJobByUuid', event });

    which makes using that alot easier:

    const { job } = await getJobByUuid({ uuid: '__uuid__' });
    // ...do amazing things with job

    now you can just create a file of those typed lambda function methods, like above, and export each one, and let that be your client.

    namespace (if you like)

    alternatively, you can build a full namespaced client:

    // export the namespaced client
    export const jobsServiceClient = {
      getJobByUuid,
      // other methods...
    };

    and add extra context about "where" getJobByUuid is coming from

    import { jobsServiceClient } from '../path/to/client';
     
    const { job } = await jobsServiceClient.getJobByUuid({ uuid: '__uuid__' });
    // ...do amazing things with job

    Tips

    lambda permissions

    if you're using this client from inside a lambda, ensure that this lambda has permission to invoke other lambdas

    # serverless.yml
    iamRoleStatements:
      - Effect: Allow
        Action:
          - lambda:InvokeFunction
          - lambda:InvokeAsync
        Resource: '*' # TODO: constrain to a specific account, region, service, and stage

    Install

    npm i lambda-service-client

    DownloadsWeekly Downloads

    1

    Version

    2.0.0

    License

    MIT

    Unpacked Size

    15.1 kB

    Total Files

    15

    Last publish

    Collaborators

    • uladkasach