Skip to content

Commit

Permalink
chore: add a snapshot test
Browse files Browse the repository at this point in the history
  • Loading branch information
flyingImer committed Mar 2, 2022
1 parent e14d9b4 commit aa07b73
Show file tree
Hide file tree
Showing 5 changed files with 380 additions and 21 deletions.
78 changes: 68 additions & 10 deletions API.md
Original file line number Diff line number Diff line change
@@ -1,38 +1,96 @@
# API Reference <a name="API Reference" id="api-reference"></a>

## Constructs <a name="Constructs" id="Constructs"></a>

### DistributedSemaphore <a name="DistributedSemaphore" id="cdk-concurrency-controller.DistributedSemaphore"></a>

## Classes <a name="Classes" id="Classes"></a>

### Hello <a name="Hello" id="cdk-concurrency-controller.Hello"></a>

#### Initializers <a name="Initializers" id="cdk-concurrency-controller.Hello.Initializer"></a>
#### Initializers <a name="Initializers" id="cdk-concurrency-controller.DistributedSemaphore.Initializer"></a>

```typescript
import { Hello } from 'cdk-concurrency-controller'
import { DistributedSemaphore } from 'cdk-concurrency-controller'

new Hello()
new DistributedSemaphore(scope: Construct, id: string)
```

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#cdk-concurrency-controller.DistributedSemaphore.Initializer.parameter.scope">scope</a></code> | <code>monocdk.Construct</code> | *No description.* |
| <code><a href="#cdk-concurrency-controller.DistributedSemaphore.Initializer.parameter.id">id</a></code> | <code>string</code> | *No description.* |

---

##### `scope`<sup>Required</sup> <a name="scope" id="cdk-concurrency-controller.DistributedSemaphore.Initializer.parameter.scope"></a>

- *Type:* monocdk.Construct

---

##### `id`<sup>Required</sup> <a name="id" id="cdk-concurrency-controller.DistributedSemaphore.Initializer.parameter.id"></a>

- *Type:* string

---

#### Methods <a name="Methods" id="Methods"></a>

| **Name** | **Description** |
| --- | --- |
| <code><a href="#cdk-concurrency-controller.Hello.sayHello">sayHello</a></code> | *No description.* |
| <code><a href="#cdk-concurrency-controller.DistributedSemaphore.toString">toString</a></code> | Returns a string representation of this construct. |

---

##### `sayHello` <a name="sayHello" id="cdk-concurrency-controller.Hello.sayHello"></a>
##### `toString` <a name="toString" id="cdk-concurrency-controller.DistributedSemaphore.toString"></a>

```typescript
public sayHello(): string
public toString(): string
```

Returns a string representation of this construct.

#### Static Functions <a name="Static Functions" id="Static Functions"></a>

| **Name** | **Description** |
| --- | --- |
| <code><a href="#cdk-concurrency-controller.DistributedSemaphore.isConstruct">isConstruct</a></code> | Return whether the given object is a Construct. |

---

##### `isConstruct` <a name="isConstruct" id="cdk-concurrency-controller.DistributedSemaphore.isConstruct"></a>

```typescript
import { DistributedSemaphore } from 'cdk-concurrency-controller'

DistributedSemaphore.isConstruct(x: any)
```

Return whether the given object is a Construct.

###### `x`<sup>Required</sup> <a name="x" id="cdk-concurrency-controller.DistributedSemaphore.isConstruct.parameter.x"></a>

- *Type:* any

---

#### Properties <a name="Properties" id="Properties"></a>

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code><a href="#cdk-concurrency-controller.DistributedSemaphore.property.node">node</a></code> | <code>monocdk.ConstructNode</code> | The construct tree node associated with this construct. |

---

##### `node`<sup>Required</sup> <a name="node" id="cdk-concurrency-controller.DistributedSemaphore.property.node"></a>

```typescript
public readonly node: ConstructNode;
```

- *Type:* monocdk.ConstructNode

The construct tree node associated with this construct.

---




Expand Down
6 changes: 0 additions & 6 deletions src/index.ts
Original file line number Diff line number Diff line change
Expand Up @@ -4,12 +4,6 @@ import { AttributeType, BillingMode, Table } from 'monocdk/aws-dynamodb';
import { Choice, Condition, Errors, IChainable, JsonPath, Parallel, Pass, StateMachine, Succeed, Wait, WaitTime } from 'monocdk/aws-stepfunctions';
import { DynamoAttributeValue, DynamoGetItem, DynamoProjectionExpression, DynamoPutItem, DynamoReturnValues, DynamoUpdateItem } from 'monocdk/aws-stepfunctions-tasks';

export class Hello {
public sayHello() {
return 'hello, world!';
}
}

export class DistributedSemaphore extends Construct {
constructor(scope: Construct, id: string) {
super(scope, id);
Expand Down
Loading

0 comments on commit aa07b73

Please sign in to comment.