@lifeomic/test-tool-localstack
TypeScript icon, indicating that this package has built-in type declarations

5.2.0 • Public • Published

@lifeomic/test-tool-localstack

npm Build Status

Localstack docker setup and run tools.

startLocalstackDocker

Starts up a localstack docker instance with specified services.

LocalstackConnectionOptions

Option (default) Description
versionTag = 0.14 Which version of localstack to use, must be >= 0.12.20. Not allowed to be latest.
nameTag = '' Which of the three variants to use, light or full, with nothing specified defaulting to the localstack/localstack default which is light
services A list of SERVICES to start. Comma-separated list of AWS CLI service names or shorthands to start up.
envVariables Other environment variables to start the localstack instance with
localstackPort = 4566 Tell Localstack which port to use. Should probably use different ones when running on CI systems

Returns a LocalstackConnection type.

interface LocalstackConnection extends awsUtils.ConnectionAndConfig {
  getOutput: () => string;
  clearOutput: () => void;
  cleanup: () => Promise<void>;
}

Hooks

Test framework convenience method.

import { localstackHooks } from '@lifeomic/test-tool-localstack'

const hooks = localstackHooks();
let

beforeAll(async () => {
  
})

Readme

Keywords

none

Package Sidebar

Install

npm i @lifeomic/test-tool-localstack

Weekly Downloads

47

Version

5.2.0

License

MIT

Unpacked Size

32.7 kB

Total Files

12

Last publish

Collaborators

  • lifeomicdev
  • npm-lifeomicdev-github