JSPM

  • Created
  • Published
  • 0
  • Score
    100M100P100Q20631F
  • License MIT

Typescript AWS API Gateway Helper

Package Exports

  • typescript-aws-apigateway-helper
  • typescript-aws-apigateway-helper/lib/index.js

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (typescript-aws-apigateway-helper) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

typescript-aws-apigateway-helper

Typescript helper functions for AWS API Gateway

CI/CD codecov NPM Version Downloads

Install

npm install typescript-aws-apigateway-helper@latest

Usage

Default - running in Lambda in your own account

const logger = new Logger(LogLevel.Trace);

const helper = new APIGatewayHelper(logger);

const response = await helper.CreateApiKeyAsync(
  'apiKey',
  'description',
  'value',
);

Running in separate account or not in Lambda

import * as APIGateway from '@aws-sdk/client-api-gateway';

const logger = new Logger(LogLevel.Trace);

const options: APIGateway.APIGatewayClientConfig = {
  accessKeyId: '{access_key}',
  secretAccessKey: '{secret_key}',
  region: 'us-east-1',
};

const repository = new APIGateway.APIGateway(options);

const helper = new APIGatewayHelper(logger, repository);

const response = await helper.CreateApiKeyAsync(
  'apiKey',
  'description',
  'value',
);

Notes

If no options are supplied, will default to us-east-1 as the region

Development

Clone the latest and run

npm run prep

to install packages and prep the git hooks