serverless-spy/doc/SNS.md

CDK-based library for writing elegant integration tests on AWS serverless architecture and an additional web console to monitor events in real time.

# SNS

SNS integration has two types of methods:
 - `waitForSnsTopicXxx()` - Intercept all events received by SNS.
 - `waitForSnsSubscriptionXxxYyy` - Intercept all events received by SNS subscription. If the subscription has no filters, it is the same as the previous method.

Basic example:

```typescript
await serverlessSpyListener.waitForSnsTopicMyTopic();

await serverlessSpyListener.waitForSnsSubscriptionMyTopicMyLambda();    
```

You can use conditions to wait for a particular event. You can also use generic (`TestData`) to strongly type the event.

```typescript    
await serverlessSpyListener.waitForSnsTopicMyTopic<TestData>({
  condition: (d) => d.message.id === id,
});

await serverlessSpyListener.waitForSnsSubscriptionMyTopicMyLambda<TestData>({
    condition: (d) => d.message.id === id,
});    
```
Check [this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/lambdaToSnS.test.ts){:target="_blank"} and 
[this](https://github.com/ServerlessLife/serverless-spy/blob/main/test/cdk/test/snsToLambda.test.ts){:target="_blank"} test.