# API Reference
## Constructs
### ServerlessSpy
#### Initializers
```typescript
import { ServerlessSpy } from 'serverless-spy'
new ServerlessSpy(scope: Construct, id: string, props?: ServerlessSpyProps)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| scope | constructs.Construct | *No description.* |
| id | string | *No description.* |
| props | ServerlessSpyProps | *No description.* |
---
##### `scope`Required
- *Type:* constructs.Construct
---
##### `id`Required
- *Type:* string
---
##### `props`Optional
- *Type:* ServerlessSpyProps
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| getConstructName | *No description.* |
| spy | Initalize spying on resources. |
| spyNodes | Initalize spying on resources given as parameter. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `getConstructName`
```typescript
public getConstructName(construct: IConstruct): string
```
###### `construct`Required
- *Type:* constructs.IConstruct
---
##### `spy`
```typescript
public spy(filter?: SpyFilter): void
```
Initalize spying on resources.
###### `filter`Optional
- *Type:* SpyFilter
Limit which resources to spy on.
---
##### `spyNodes`
```typescript
public spyNodes(nodes: IConstruct[]): void
```
Initalize spying on resources given as parameter.
###### `nodes`Required
- *Type:* constructs.IConstruct[]
Which reources and their children to spy on.
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
---
##### `isConstruct`
```typescript
import { ServerlessSpy } from 'serverless-spy'
ServerlessSpy.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| serviceKeys | string[] | *No description.* |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `serviceKeys`Required
```typescript
public readonly serviceKeys: string[];
```
- *Type:* string[]
---
## Structs
### ServerlessSpyProps
#### Initializer
```typescript
import { ServerlessSpyProps } from 'serverless-spy'
const serverlessSpyProps: ServerlessSpyProps = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| debugMode | boolean | *No description.* |
| generateSpyEventsFileLocation | string | *No description.* |
| spySqsWithNoSubscriptionAndDropAllMessages | boolean | *No description.* |
---
##### `debugMode`Optional
```typescript
public readonly debugMode: boolean;
```
- *Type:* boolean
---
##### `generateSpyEventsFileLocation`Optional
```typescript
public readonly generateSpyEventsFileLocation: string;
```
- *Type:* string
---
##### `spySqsWithNoSubscriptionAndDropAllMessages`Optional
```typescript
public readonly spySqsWithNoSubscriptionAndDropAllMessages: boolean;
```
- *Type:* boolean
---
### SpyFilter
#### Initializer
```typescript
import { SpyFilter } from 'serverless-spy'
const spyFilter: SpyFilter = { ... }
```
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| spyDynamoDB | boolean | *No description.* |
| spyEventBridge | boolean | *No description.* |
| spyEventBridgeRule | boolean | *No description.* |
| spyLambda | boolean | *No description.* |
| spyS3 | boolean | *No description.* |
| spySnsSubsription | boolean | *No description.* |
| spySnsTopic | boolean | *No description.* |
| spySqs | boolean | *No description.* |
---
##### `spyDynamoDB`Optional
```typescript
public readonly spyDynamoDB: boolean;
```
- *Type:* boolean
---
##### `spyEventBridge`Optional
```typescript
public readonly spyEventBridge: boolean;
```
- *Type:* boolean
---
##### `spyEventBridgeRule`Optional
```typescript
public readonly spyEventBridgeRule: boolean;
```
- *Type:* boolean
---
##### `spyLambda`Optional
```typescript
public readonly spyLambda: boolean;
```
- *Type:* boolean
---
##### `spyS3`Optional
```typescript
public readonly spyS3: boolean;
```
- *Type:* boolean
---
##### `spySnsSubsription`Optional
```typescript
public readonly spySnsSubsription: boolean;
```
- *Type:* boolean
---
##### `spySnsTopic`Optional
```typescript
public readonly spySnsTopic: boolean;
```
- *Type:* boolean
---
##### `spySqs`Optional
```typescript
public readonly spySqs: boolean;
```
- *Type:* boolean
---