TypeScript SDK

Install and use the fakecloud SDK for TypeScript and JavaScript tests.

Install

npm install fakecloud

Works in Node.js and any environment with fetch. TypeScript types are bundled.

Initialize

import { FakeCloud } from "fakecloud";

const fc = new FakeCloud(); // defaults to http://localhost:4566
// or
const fc = new FakeCloud("http://localhost:5000");

Top-level

fc.acm

fc.apigatewayv2

fc.applicationAutoscaling

fc.athena

fc.bedrock

fc.bedrockAgent

fc.bedrockAgentRuntime

fc.cloudfront

fc.cognito

fc.dynamodb

fc.ecr

fc.ecs

fc.elasticache

fc.elbv2

fc.events

fc.glue

fc.kms

fc.lambda

fc.logs

fc.organizations

fc.rds

fc.route53

fc.s3

fc.scheduler

fc.secretsmanager

fc.ses

fc.sns

fc.sqs

fc.ssm

fc.stepfunctions

fc.wafv2

Error handling

All methods throw FakeCloudError on non-2xx responses:

import { FakeCloudError } from "fakecloud";

try {
  await fc.cognito.confirmUser({ userPoolId: "pool-1", username: "nobody" });
} catch (err) {
  if (err instanceof FakeCloudError) {
    console.log(err.status); // 404
    console.log(err.body);   // error body from fakecloud
  }
}

Example: full test loop

import { FakeCloud } from "fakecloud";
import { SQSClient, SendMessageCommand } from "@aws-sdk/client-sqs";

const fc = new FakeCloud();
const sqs = new SQSClient({
  endpoint: "http://localhost:4566",
  region: "us-east-1",
  credentials: { accessKeyId: "test", secretAccessKey: "test" },
});

beforeEach(() => fc.reset());

test("app publishes to SQS", async () => {
  await sqs.send(new SendMessageCommand({
    QueueUrl: "http://localhost:4566/000000000000/my-queue",
    MessageBody: "hello",
  }));

  const { messages } = await fc.sqs.getMessages();
  expect(messages).toHaveLength(1);
  expect(messages[0].body).toBe("hello");
});

Source

• sdks/typescript
• Source README -- always-current method list