From 80153562f2ad8f403c8a1226f7b7a917c1e05e4e Mon Sep 17 00:00:00 2001
From: wingbot <109207340+monadabot@users.noreply.github.com>
Date: Wed, 4 Sep 2024 22:18:55 +0200
Subject: [PATCH] feat(docs): update docs (#1004)
Co-authored-by: mergify[bot] <37929162+mergify[bot]@users.noreply.github.com>
---
.../version-latest/04-winglibs/04-toc.md | 54 ++--
.../04-winglibs/05-winglibs/bedrock.md | 32 +-
.../04-winglibs/05-winglibs/budget.md | 80 +++--
.../04-winglibs/05-winglibs/checks.md | 72 +++--
.../04-winglibs/05-winglibs/cloudv2.md | 54 ++--
.../04-winglibs/05-winglibs/dynamodb.md | 250 +++++++++------
.../04-winglibs/05-winglibs/eventbridge.md | 126 +++++---
.../04-winglibs/05-winglibs/fifoqueue.md | 72 +++--
.../04-winglibs/05-winglibs/github.md | 290 +++++++++++-------
.../04-winglibs/05-winglibs/jwt.md | 42 ++-
.../04-winglibs/05-winglibs/k8s.md | 24 +-
.../04-winglibs/05-winglibs/lock.md | 24 +-
.../04-winglibs/05-winglibs/messagefanout.md | 60 ++--
.../04-winglibs/05-winglibs/momento.md | 44 ++-
.../04-winglibs/05-winglibs/ngrok.md | 32 +-
.../04-winglibs/05-winglibs/openai.md | 30 +-
.../04-winglibs/05-winglibs/postgres.md | 58 ++--
.../04-winglibs/05-winglibs/react.md | 88 +++---
.../04-winglibs/05-winglibs/redis.md | 62 ++--
.../04-winglibs/05-winglibs/sagemaker.md | 66 ++--
.../04-winglibs/05-winglibs/ses.md | 118 ++++---
.../04-winglibs/05-winglibs/simtools.md | 18 +-
.../04-winglibs/05-winglibs/slack.md | 168 +++++-----
.../04-winglibs/05-winglibs/sns.md | 70 +++--
.../04-winglibs/05-winglibs/tf.md | 58 ++--
.../04-winglibs/05-winglibs/tsoa.md | 78 +++--
.../04-winglibs/05-winglibs/vite.md | 52 ++--
.../04-winglibs/05-winglibs/websockets.md | 100 +++---
28 files changed, 1332 insertions(+), 890 deletions(-)
diff --git a/versioned_docs/version-latest/04-winglibs/04-toc.md b/versioned_docs/version-latest/04-winglibs/04-toc.md
index 4ad6d4da..1dacac6b 100644
--- a/versioned_docs/version-latest/04-winglibs/04-toc.md
+++ b/versioned_docs/version-latest/04-winglibs/04-toc.md
@@ -8,36 +8,36 @@ keywords: [winglib, Wing library]
| Library | Package name | Version | Description | Supported Wing platforms |
| -------- | ------- | ------- | ------- | ------- |
-| [Amazon Bedrock](/docs/winglibs/winglibs/bedrock) | [@winglibs/bedrock](/docs/winglibs/winglibs/bedrock) | v0.1.1 | A Wing library for Amazon Bedrock | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [AWS Budget](/docs/winglibs/winglibs/budget) | [@winglibs/budget](/docs/winglibs/winglibs/budget) | v0.1.6 | A Wing library for working with [AWS Budgets] | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Cloud checks](/docs/winglibs/winglibs/checks) | [@winglibs/checks](/docs/winglibs/winglibs/checks) | v0.0.17 | A self-validation mechanism for cloud applications | [*](/docs/platforms/platforms) |
-| [cloudv2](/docs/winglibs/winglibs/cloudv2) | [@winglibs/cloudv2](/docs/winglibs/winglibs/cloudv2) | v0.1.1 | Standard cloud library for Wing | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon Bedrock](/docs/winglibs/winglibs/bedrock) | [@winglibs/bedrock](/docs/winglibs/winglibs/bedrock) | v0.1.2 | A Wing library for Amazon Bedrock | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [AWS Budget](/docs/winglibs/winglibs/budget) | [@winglibs/budget](/docs/winglibs/winglibs/budget) | v0.1.7 | A Wing library for working with [AWS Budgets] | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Cloud checks](/docs/winglibs/winglibs/checks) | [@winglibs/checks](/docs/winglibs/winglibs/checks) | v0.0.18 | A self-validation mechanism for cloud applications | [*](/docs/platforms/platforms) |
+| [cloudv2](/docs/winglibs/winglibs/cloudv2) | [@winglibs/cloudv2](/docs/winglibs/winglibs/cloudv2) | v0.1.2 | Standard cloud library for Wing | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
| [Amazon Cognito](/docs/winglibs/winglibs/cognito) | [@winglibs/cognito](/docs/winglibs/winglibs/cognito) | v0.0.14 | A wing library to work with Amazon Cognito | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
| [Containers](/docs/winglibs/winglibs/containers) | [@winglibs/containers](/docs/winglibs/winglibs/containers) | v0.1.6 | Deploy containers with Wing | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon DynamoDB](/docs/winglibs/winglibs/dynamodb) | [@winglibs/dynamodb](/docs/winglibs/winglibs/dynamodb) | v0.2.2 | A Wing library for Amazon DynamoDB | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon EventBridge](/docs/winglibs/winglibs/eventbridge) | [@winglibs/eventbridge](/docs/winglibs/winglibs/eventbridge) | v0.1.7 | A Wing library for working with Amazon EventBridge | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
-| [FIFO Queue](/docs/winglibs/winglibs/fifoqueue) | [@winglibs/fifoqueue](/docs/winglibs/winglibs/fifoqueue) | v0.0.11 | A wing library to work with FIFO (first-in first-out) Queues | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [GitHub](/docs/winglibs/winglibs/github) | [@winglibs/github](/docs/winglibs/winglibs/github) | v0.0.15 | A wing library to work with GitHub Probot | [*](/docs/platforms/platforms) |
-| [JWT authentication](/docs/winglibs/winglibs/jwt) | [@winglibs/jwt](/docs/winglibs/winglibs/jwt) | v0.0.8 | Wing library for JWT authentication | [*](/docs/platforms/platforms) |
-| [Kubernetes (k8s)](/docs/winglibs/winglibs/k8s) | [@winglibs/k8s](/docs/winglibs/winglibs/k8s) | v0.0.9 | Wing for Kubernetes | k8s |
-| [Lock](/docs/winglibs/winglibs/lock) | [@winglibs/lock](/docs/winglibs/winglibs/lock) | v0.0.7 | Wing library for cloud lock | [*](/docs/platforms/platforms) |
-| [Message Fanout](/docs/winglibs/winglibs/messagefanout) | [@winglibs/messagefanout](/docs/winglibs/winglibs/messagefanout) | v0.0.8 | Wing library to fan out messages | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Momento](/docs/winglibs/winglibs/momento) | [@winglibs/momento](/docs/winglibs/winglibs/momento) | v0.0.5 | Wing library for [momento](https://www.gomomento.com/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [tf-gcp](/docs/platforms/google-cloud/tf-gcp), [tf-azure](/docs/platforms/microsoft-azure/tf-azure) |
-| [ngrok](/docs/winglibs/winglibs/ngrok) | [@winglibs/ngrok](/docs/winglibs/winglibs/ngrok) | v0.0.10 | Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints. | [*](/docs/platforms/platforms) |
-| [OpenAI](/docs/winglibs/winglibs/openai) | [@winglibs/openai](/docs/winglibs/winglibs/openai) | v0.0.8 | Wing library for [OpenAI](https://openai.com/) | [*](/docs/platforms/platforms) |
-| [Postgres](/docs/winglibs/winglibs/postgres) | [@winglibs/postgres](/docs/winglibs/winglibs/postgres) | v0.1.12 | Wing library for [Postgres](https://www.postgresql.org/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon DynamoDB](/docs/winglibs/winglibs/dynamodb) | [@winglibs/dynamodb](/docs/winglibs/winglibs/dynamodb) | v0.2.3 | A Wing library for Amazon DynamoDB | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon EventBridge](/docs/winglibs/winglibs/eventbridge) | [@winglibs/eventbridge](/docs/winglibs/winglibs/eventbridge) | v0.1.8 | A Wing library for working with Amazon EventBridge | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
+| [FIFO Queue](/docs/winglibs/winglibs/fifoqueue) | [@winglibs/fifoqueue](/docs/winglibs/winglibs/fifoqueue) | v0.0.12 | A wing library to work with FIFO (first-in first-out) Queues | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [GitHub](/docs/winglibs/winglibs/github) | [@winglibs/github](/docs/winglibs/winglibs/github) | v0.0.16 | A wing library to work with GitHub Probot | [*](/docs/platforms/platforms) |
+| [JWT authentication](/docs/winglibs/winglibs/jwt) | [@winglibs/jwt](/docs/winglibs/winglibs/jwt) | v0.0.9 | Wing library for JWT authentication | [*](/docs/platforms/platforms) |
+| [Kubernetes (k8s)](/docs/winglibs/winglibs/k8s) | [@winglibs/k8s](/docs/winglibs/winglibs/k8s) | v0.0.10 | Wing for Kubernetes | k8s |
+| [Lock](/docs/winglibs/winglibs/lock) | [@winglibs/lock](/docs/winglibs/winglibs/lock) | v0.0.8 | Wing library for cloud lock | [*](/docs/platforms/platforms) |
+| [Message Fanout](/docs/winglibs/winglibs/messagefanout) | [@winglibs/messagefanout](/docs/winglibs/winglibs/messagefanout) | v0.0.9 | Wing library to fan out messages | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Momento](/docs/winglibs/winglibs/momento) | [@winglibs/momento](/docs/winglibs/winglibs/momento) | v0.0.6 | Wing library for [momento](https://www.gomomento.com/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [tf-gcp](/docs/platforms/google-cloud/tf-gcp), [tf-azure](/docs/platforms/microsoft-azure/tf-azure) |
+| [ngrok](/docs/winglibs/winglibs/ngrok) | [@winglibs/ngrok](/docs/winglibs/winglibs/ngrok) | v0.0.11 | Wing library for [ngrok](https://ngrok.com/). Create local tunnels to Wing endpoints. | [*](/docs/platforms/platforms) |
+| [OpenAI](/docs/winglibs/winglibs/openai) | [@winglibs/openai](/docs/winglibs/winglibs/openai) | v0.0.9 | Wing library for [OpenAI](https://openai.com/) | [*](/docs/platforms/platforms) |
+| [Postgres](/docs/winglibs/winglibs/postgres) | [@winglibs/postgres](/docs/winglibs/winglibs/postgres) | v0.1.13 | Wing library for [Postgres](https://www.postgresql.org/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
| [Python](/docs/winglibs/winglibs/python) | [@winglibs/python](/docs/winglibs/winglibs/python) | v0.1.4 | A Wing library for running [Python](https://www.python.org/) code in [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code). | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [React](/docs/winglibs/winglibs/react) | [@winglibs/react](/docs/winglibs/winglibs/react) | v0.1.5 | A Wing library for [React](https://react.dev/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Redis](/docs/winglibs/winglibs/redis) | [@winglibs/redis](/docs/winglibs/winglibs/redis) | v0.0.12 | A Wing library for [Redis](https://redis.io/) ([Example](https://www.winglang.io/docs/examples/redis)) | [sim](/docs/platforms/sim) |
-| [Amazon SageMaker](/docs/winglibs/winglibs/sagemaker) | [@winglibs/sagemaker](/docs/winglibs/winglibs/sagemaker) | v0.0.9 | The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code) code. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon SES](/docs/winglibs/winglibs/ses) | [@winglibs/ses](/docs/winglibs/winglibs/ses) | v0.0.7 | Wing library for interacting with Amazon SES. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Wing simulator utils](/docs/winglibs/winglibs/simtools) | [@winglibs/simtools](/docs/winglibs/winglibs/simtools) | v0.0.5 | '[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library' | [sim](/docs/platforms/sim) |
-| [Slack](/docs/winglibs/winglibs/slack) | [@winglibs/slack](/docs/winglibs/winglibs/slack) | v0.1.4 | A Wing library for working with [Slack](https://slack.com/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [Amazon SNS](/docs/winglibs/winglibs/sns) | [@winglibs/sns](/docs/winglibs/winglibs/sns) | v0.1.6 | A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/) | [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk), [sim](/docs/platforms/sim) |
-| [Terraform utilities](/docs/winglibs/winglibs/tf) | [@winglibs/tf](/docs/winglibs/winglibs/tf) | v0.0.8 | Terraform utilities library for Wing | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [tsoa](/docs/winglibs/winglibs/tsoa) | [@winglibs/tsoa](/docs/winglibs/winglibs/tsoa) | v0.1.14 | A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript. | [sim](/docs/platforms/sim) |
-| [Vite](/docs/winglibs/winglibs/vite) | [@winglibs/vite](/docs/winglibs/winglibs/vite) | v0.2.4 | A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
-| [WebSocket](/docs/winglibs/winglibs/websockets) | [@winglibs/websockets](/docs/winglibs/winglibs/websockets) | v0.3.12 | A Wing library that enables you to create WebSockets using Wing. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
+| [React](/docs/winglibs/winglibs/react) | [@winglibs/react](/docs/winglibs/winglibs/react) | v0.1.6 | A Wing library for [React](https://react.dev/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Redis](/docs/winglibs/winglibs/redis) | [@winglibs/redis](/docs/winglibs/winglibs/redis) | v0.0.13 | A Wing library for [Redis](https://redis.io/) ([Example](https://www.winglang.io/docs/examples/redis)) | [sim](/docs/platforms/sim) |
+| [Amazon SageMaker](/docs/winglibs/winglibs/sagemaker) | [@winglibs/sagemaker](/docs/winglibs/winglibs/sagemaker) | v0.0.10 | The library enables owners of a trained sagemaker model, to access its Endpoints from a winglang [inflight](https://www.winglang.io/docs/concepts/inflights#inflight-code) code. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon SES](/docs/winglibs/winglibs/ses) | [@winglibs/ses](/docs/winglibs/winglibs/ses) | v0.0.8 | Wing library for interacting with Amazon SES. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Wing simulator utils](/docs/winglibs/winglibs/simtools) | [@winglibs/simtools](/docs/winglibs/winglibs/simtools) | v0.0.6 | '[Wing simulator](https://www.winglang.io/docs/platforms/sim) utility library' | [sim](/docs/platforms/sim) |
+| [Slack](/docs/winglibs/winglibs/slack) | [@winglibs/slack](/docs/winglibs/winglibs/slack) | v0.1.5 | A Wing library for working with [Slack](https://slack.com/) | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [Amazon SNS](/docs/winglibs/winglibs/sns) | [@winglibs/sns](/docs/winglibs/winglibs/sns) | v0.1.7 | A Wing library for working with [Amazon SNS](https://aws.amazon.com/sns/) | [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk), [sim](/docs/platforms/sim) |
+| [Terraform utilities](/docs/winglibs/winglibs/tf) | [@winglibs/tf](/docs/winglibs/winglibs/tf) | v0.0.9 | Terraform utilities library for Wing | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [tsoa](/docs/winglibs/winglibs/tsoa) | [@winglibs/tsoa](/docs/winglibs/winglibs/tsoa) | v0.1.15 | A Wing library for working with [TSOA](https://tsoa-community.github.io/docs/) - An OpenAPI-compliant Web APIs using TypeScript. | [sim](/docs/platforms/sim) |
+| [Vite](/docs/winglibs/winglibs/vite) | [@winglibs/vite](/docs/winglibs/winglibs/vite) | v0.2.5 | A Wing library to deploy [Vite applications](https://vitejs.dev/) to the cloud. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws) |
+| [WebSocket](/docs/winglibs/winglibs/websockets) | [@winglibs/websockets](/docs/winglibs/winglibs/websockets) | v0.3.13 | A Wing library that enables you to create WebSockets using Wing. | [sim](/docs/platforms/sim), [tf-aws](/docs/platforms/AWS/tf-aws), [awscdk](/docs/platforms/AWS/awscdk) |
## Contributing to winglibs
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md
index c938667d..24ef05e4 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/bedrock.md
@@ -65,47 +65,51 @@ handled by the mocked service.
This library is licensed under the [MIT License](./LICENSE).
---
-
API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- JokeMaker
- Model
-JokeMaker (preflight class)
+### JokeMaker (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): JokeMaker
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight makeJoke(topic: str): str
| *No description* |
-Model (preflight class)
+### Model (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(modelId: str): Model
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| modelId
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md
index a6068136..0dfaf527 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/budget.md
@@ -49,9 +49,9 @@ You get an alert when your monthly payment goes over your budget.
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Alert
@@ -65,85 +65,97 @@ This library is licensed under the [MIT License](./LICENSE).
- **Enums**
- TimeUnit
-Alert (preflight class)
+### Alert (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: AlertProps): Alert
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
*No methods*
-AlertTfAws (preflight class)
+### AlertTfAws (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: AlertProps): AlertTfAws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
*No methods*
-AlertSim (preflight class)
+### AlertSim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: AlertProps): AlertSim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
*No methods*
-Util (preflight class)
+### Util (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(): Util
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static timeUnitToStr(timeUnit: TimeUnit): str
| *No description* |
-IAlert (interface)
+### IAlert (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
*No methods*
-AlertProps (struct)
+### AlertProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -152,9 +164,11 @@ new(): Util
| name
| str
| *No description* |
| timeUnit
| TimeUnit?
| *No description* |
-TimeUnit (enum)
+### TimeUnit (enum)
+
+*No description*
-Values
+#### Values
| **Name** | **Description** |
| --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/checks.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/checks.md
index f960481d..aef37012 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/checks.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/checks.md
@@ -158,9 +158,9 @@ let allResults = resultsBucket.list();
Licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Results
@@ -173,19 +173,21 @@ Licensed under the [MIT License](./LICENSE).
- CheckProps
- CheckHttpProps
-Results (preflight class)
+### Results (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Results
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -193,60 +195,68 @@ new(): Results
| static of(scope: IResource): Results
| *No description* |
| inflight store(result: CheckResult): void
| *No description* |
-Check (preflight class)
+### Check (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(handler: inflight (): void, props: CheckProps?): Check
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight latest(): CheckResult?
| *No description* |
| inflight run(): CheckResult
| *No description* |
-CheckHttp (preflight class)
+### CheckHttp (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(url: str, options: CheckHttpProps?): CheckHttp
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight latest(): CheckResult?
| *No description* |
| inflight run(): CheckResult
| *No description* |
-ICheck (interface)
+### ICheck (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight latest(): CheckResult?
| *No description* |
| inflight run(): CheckResult
| *No description* |
-CheckResult (struct)
+### CheckResult (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -256,9 +266,11 @@ new(url: str, options: CheckHttpProps?): CheckHttp
| ok
| bool
| *No description* |
| timestamp
| str
| *No description* |
-CheckProps (struct)
+### CheckProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -266,9 +278,11 @@ new(url: str, options: CheckHttpProps?): CheckHttp
| rate
| duration?
| *No description* |
| testing
| bool?
| *No description* |
-CheckHttpProps (struct)
+### CheckHttpProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/cloudv2.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/cloudv2.md
index 574798f0..f62c4fe2 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/cloudv2.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/cloudv2.md
@@ -35,9 +35,9 @@ let counter = new cloud.Counter();
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Counter
@@ -48,21 +48,23 @@ This library is licensed under the [MIT License](./LICENSE).
- **Structs**
- CounterProps
-Counter (preflight class)
+### Counter (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: CounterProps): Counter
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| initial
| num
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -71,31 +73,35 @@ new(props: CounterProps): Counter
| inflight peek(key: str?): num
| *No description* |
| inflight set(value: num, key: str?): void
| *No description* |
-AwsCounter (preflight class)
+### AwsCounter (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): AwsCounter
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static from(c: ICounter): IAwsCounter?
| *No description* |
-ICounter (interface)
+### ICounter (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -104,22 +110,26 @@ new(): AwsCounter
| inflight peek(key: str?): num
| Returns the current value of the counter. - `key` The key of the counter (defaults to "default") |
| inflight set(value: num, key: str?): void
| Sets the value of the counter. - `value` The new value of the counter - `key` The key of the counter (defaults to "default") |
-IAwsCounter (interface)
+### IAwsCounter (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| dynamoTableArn(): str
| *No description* |
| dynamoTableName(): str
| *No description* |
-CounterProps (struct)
+### CounterProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/dynamodb.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/dynamodb.md
index ebf80fe8..560127a3 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/dynamodb.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/dynamodb.md
@@ -76,9 +76,9 @@ new DynamoDB(table.connection.clientConfig);
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Table
@@ -119,22 +119,24 @@ This library is licensed under the [MIT License](./LICENSE).
- UpdateOutput
- ClientProps
-Table (preflight class)
+### Table (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: TableProps): Table
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| connection
| Connection
| *No description* |
| tableName
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -148,22 +150,24 @@ new(props: TableProps): Table
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-Table_tfaws (preflight class)
+### Table_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: TableProps): Table_tfaws
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| connection
| Connection
| *No description* |
| tableName
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -177,22 +181,24 @@ new(props: TableProps): Table_tfaws
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-Table_sim (preflight class)
+### Table_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: TableProps): Table_sim
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| connection
| Connection
| *No description* |
| tableName
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -206,19 +212,21 @@ new(props: TableProps): Table_sim
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-Client (inflight class)
+### Client (inflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Client
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -230,13 +238,15 @@ new(): Client
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-IClient (interface)
+### IClient (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -248,15 +258,17 @@ new(): Client
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-ITable (interface)
+### ITable (interface)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -270,18 +282,22 @@ new(): Client
| inflight transactWrite(options: TransactWriteOptions): TransactWriteOutput
| *No description* |
| inflight update(options: UpdateOptions): UpdateOutput
| *No description* |
-AttributeDefinition (struct)
+### AttributeDefinition (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name
| str
| *No description* |
| type
| str
| *No description* |
-ClientConfig (struct)
+### ClientConfig (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -289,27 +305,33 @@ new(): Client
| endpoint
| str
| *No description* |
| region
| str
| *No description* |
-Connection (struct)
+### Connection (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| clientConfig
| ClientConfig?
| *No description* |
| tableName
| str
| *No description* |
-Credentials (struct)
+### Credentials (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| accessKeyId
| str
| *No description* |
| secretAccessKey
| str
| *No description* |
-DeleteOptions (struct)
+### DeleteOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -319,17 +341,21 @@ new(): Client
| Key
| Json
| *No description* |
| ReturnValues
| str?
| *No description* |
-DeleteOutput (struct)
+### DeleteOutput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Attributes
| Json?
| *No description* |
-GetOptions (struct)
+### GetOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -339,17 +365,21 @@ new(): Client
| Key
| Json
| *No description* |
| ProjectionExpression
| str?
| *No description* |
-GetOutput (struct)
+### GetOutput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Item
| Json?
| *No description* |
-GlobalSecondaryIndex (struct)
+### GlobalSecondaryIndex (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -361,9 +391,11 @@ new(): Client
| readCapacity
| num?
| *No description* |
| writeCapacity
| num?
| *No description* |
-PutOptions (struct)
+### PutOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -373,17 +405,21 @@ new(): Client
| Item
| Json
| *No description* |
| ReturnValues
| str?
| *No description* |
-PutOutput (struct)
+### PutOutput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Attributes
| Json?
| *No description* |
-QueryOptions (struct)
+### QueryOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -400,9 +436,11 @@ new(): Client
| ScanIndexForward
| bool?
| *No description* |
| Select
| str?
| *No description* |
-QueryOutput (struct)
+### QueryOutput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -412,9 +450,11 @@ new(): Client
| LastEvaluatedKey
| Json?
| *No description* |
| ScannedCount
| num
| *No description* |
-ScanOptions (struct)
+### ScanOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -431,9 +471,11 @@ new(): Client
| Select
| str?
| *No description* |
| TotalSegments
| num?
| *No description* |
-ScanOutput (struct)
+### ScanOutput (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -443,18 +485,22 @@ new(): Client
| LastEvaluatedKey
| Json?
| *No description* |
| ScannedCount
| num
| *No description* |
-StreamConsumerOptions (struct)
+### StreamConsumerOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| batchSize
| num?
| *No description* |
| startingPosition
| str?
| *No description* |
-StreamRecord (struct)
+### StreamRecord (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -462,9 +508,11 @@ new(): Client
| eventID
| str
| *No description* |
| eventName
| str
| *No description* |
-StreamRecordDynamodb (struct)
+### StreamRecordDynamodb (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -476,9 +524,11 @@ new(): Client
| SizeBytes
| num
| *No description* |
| StreamViewType
| str
| *No description* |
-TableProps (struct)
+### TableProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -490,9 +540,11 @@ new(): Client
| rangeKey
| str?
| *No description* |
| timeToLiveAttribute
| str?
| *No description* |
-TransactWriteItem (struct)
+### TransactWriteItem (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -501,9 +553,11 @@ new(): Client
| Put
| TransactWriteItemPut?
| *No description* |
| Update
| TransactWriteItemUpdate?
| *No description* |
-TransactWriteItemConditionCheck (struct)
+### TransactWriteItemConditionCheck (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -513,9 +567,11 @@ new(): Client
| Key
| Json
| *No description* |
| ReturnValuesOnConditionCheckFailure
| bool?
| *No description* |
-TransactWriteItemDelete (struct)
+### TransactWriteItemDelete (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -525,9 +581,11 @@ new(): Client
| Key
| Json
| *No description* |
| ReturnValuesOnConditionCheckFailure
| bool?
| *No description* |
-TransactWriteItemPut (struct)
+### TransactWriteItemPut (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -537,9 +595,11 @@ new(): Client
| Item
| Json
| *No description* |
| ReturnValuesOnConditionCheckFailure
| bool?
| *No description* |
-TransactWriteItemUpdate (struct)
+### TransactWriteItemUpdate (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -550,23 +610,29 @@ new(): Client
| ReturnValuesOnConditionCheckFailure
| bool?
| *No description* |
| UpdateExpression
| str?
| *No description* |
-TransactWriteOptions (struct)
+### TransactWriteOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| TransactItems
| Array
| *No description* |
-TransactWriteOutput (struct)
+### TransactWriteOutput (struct)
+
+*No description*
-Properties
+#### Properties
*No properties*
-UpdateOptions (struct)
+### UpdateOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -578,9 +644,11 @@ new(): Client
| ReturnValues
| str?
| *No description* |
| UpdateExpression
| str
| *No description* |
-UpdateOutput (struct)
+### UpdateOutput (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -590,9 +658,11 @@ new(): Client
| Item
| Json
| *No description* |
| ReturnValues
| str?
| *No description* |
-ClientProps (struct)
+### ClientProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/eventbridge.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/eventbridge.md
index df2d669f..3ca36efb 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/eventbridge.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/eventbridge.md
@@ -62,9 +62,9 @@ wing compile -t @winglang/platform-awscdk -v eventBridgeName="my-bus" main.w
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Bus
@@ -82,19 +82,21 @@ This library is licensed under the [MIT License](./LICENSE).
- platform.aws.PutEventCommandEntry
- platform.aws.PutEventCommandInput
-Bus (preflight class)
+### Bus (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: BusProps?): Bus
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -102,19 +104,21 @@ new(props: BusProps?): Bus
| inflight putEvents(events: Array): void
| *No description* |
| subscribeQueue(name: str, queue: Queue, pattern: Json): void
| *No description* |
-
+### platform.tfaws.Bus (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: BusProps?): Bus
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -122,19 +126,21 @@ new(props: BusProps?): Bus
| inflight putEvents(events: Array): void
| *No description* |
| subscribeQueue(name: str, queue: Queue, pattern: Json): void
| *No description* |
-
+### platform.sim.Bus (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: BusProps?): Bus
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -142,38 +148,42 @@ new(props: BusProps?): Bus
| inflight putEvents(events: Array): void
| *No description* |
| subscribeQueue(name: str, queue: Queue, pattern: Json): void
| *No description* |
-
+### platform.sim.EventBridgeBus (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: BusProps?): EventBridgeBus
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight putEvents(events: Array): void
| *No description* |
| subscribe(callback: inflight (Event): void, pattern: Json): Resource
| *No description* |
-
+### platform.awscdk.Bus (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: BusProps?): Bus
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -182,34 +192,38 @@ new(props: BusProps?): Bus
| inflight putEvents(events: Array): void
| *No description* |
| subscribeQueue(name: str, queue: Queue, pattern: Json): void
| *No description* |
-
+### platform.aws.Util (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Util
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static inflight _putEvent(name: str, event: PutEventCommandInput): void
| *No description* |
| static inflight putEvent(name: str, events: Array): void
| *No description* |
-IBus (interface)
+### IBus (interface)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -217,18 +231,22 @@ new(): Util
| inflight putEvents(events: Array): void
| *No description* |
| subscribeQueue(name: str, queue: Queue, pattern: Json): void
| *No description* |
-BusProps (struct)
+### BusProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| debug
| bool?
| *No description* |
| name
| str
| *No description* |
-Event (struct)
+### Event (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -242,9 +260,11 @@ new(): Util
| time
| str
| *No description* |
| version
| str
| *No description* |
-PublishEvent (struct)
+### PublishEvent (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -254,9 +274,11 @@ new(): Util
| source
| str
| *No description* |
| version
| str
| *No description* |
-platform.aws.PutEventCommandEntry (struct)
+### platform.aws.PutEventCommandEntry (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -266,9 +288,11 @@ new(): Util
| Resources
| Array
| *No description* |
| Source
| str
| *No description* |
-
+### platform.aws.PutEventCommandInput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/fifoqueue.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/fifoqueue.md
index d4bafe27..c9bd1949 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/fifoqueue.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/fifoqueue.md
@@ -42,9 +42,9 @@ test "will push to queue" {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- FifoQueue
@@ -57,79 +57,89 @@ This library is licensed under the [MIT License](./LICENSE).
- PushOptions
- SetConsumerOptions
-FifoQueue (preflight class)
+### FifoQueue (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: FifoQueueProps?): FifoQueue
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight push(message: str, options: PushOptions): void
| *No description* |
| setConsumer(fn: inflight (str): void, options: SetConsumerOptions?): void
| *No description* |
-FifoQueue_sim (preflight class)
+### FifoQueue_sim (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(): FifoQueue_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight push(message: str, options: PushOptions): void
| *No description* |
| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void
| *No description* |
-FifoQueue_aws (preflight class)
+### FifoQueue_aws (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: FifoQueueProps?): FifoQueue_aws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight push(message: str, options: PushOptions): void
| *No description* |
| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void
| *No description* |
-IFifoQueue (interface)
+### IFifoQueue (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight push(message: str, options: PushOptions): void
| *No description* |
| setConsumer(handler: inflight (str): void, options: SetConsumerOptions?): void
| *No description* |
-FifoQueueProps (struct)
+### FifoQueueProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -137,17 +147,21 @@ new(props: FifoQueueProps?): FifoQueue_aws
| retentionPeriod
| duration?
| How long a queue retains a message. |
| timeout
| duration?
| How long a queue's consumers have to process a message. |
-PushOptions (struct)
+### PushOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| groupId
| str
| *No description* |
-SetConsumerOptions (struct)
+### SetConsumerOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/github.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/github.md
index 875dd1b4..35738296 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/github.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/github.md
@@ -142,9 +142,9 @@ let markdown = new github.ProbotApp(
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- ProbotApp
@@ -188,19 +188,21 @@ This library is licensed under the [MIT License](./LICENSE).
- octokit.OctoKit
- ngrok.NgrokProps
-ProbotApp (preflight class)
+### ProbotApp (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ProbotAppProps): ProbotApp
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -209,71 +211,79 @@ new(props: ProbotAppProps): ProbotApp
| onPullRequestReopened(handler: inflight (PullRequestOpenedContext): void): void
| *No description* |
| inflight updateWebhookUrl(url: str): void
| *No description* |
-utils.LowkeysMap (inflight class)
+### utils.LowkeysMap (inflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(): LowkeysMap
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static inflight fromMap(map: Map): Map
| *No description* |
-simutils.Port (preflight class)
+### simutils.Port (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(): Port
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| port
| str
| *No description* |
-Methods
+#### Methods
*No methods*
-simutils.Service (preflight class)
+### simutils.Service (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(command: str, args: Array, props: ServiceProps): Service
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
*No methods*
-probot.ProbotAdapter (preflight class)
+### probot.ProbotAdapter (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: ProbotAdapterProps): ProbotAdapter
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -286,31 +296,35 @@ new(props: ProbotAdapterProps): ProbotAdapter
| inflight handlePush(handler: inflight (PushContext): void): void
| *No description* |
| inflight verifyAndReceive(props: VerifyAndReceieveProps): void
| *No description* |
-ngrok.Ngrok (preflight class)
+### ngrok.Ngrok (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: NgrokProps): Ngrok
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
*No methods*
-IProbotAppCredentialsSupplier (interface)
+### IProbotAppCredentialsSupplier (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -318,50 +332,58 @@ new(props: NgrokProps): Ngrok
| inflight getPrivateKey(): str
| *No description* |
| inflight getWebhookSecret(): str
| *No description* |
-simutils.Process (interface)
+### simutils.Process (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight kill(): void
| *No description* |
-probot.IProbotAuth (interface)
+### probot.IProbotAuth (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight call(instance: ProbotInstance, installationId: num): OctoKit
| *No description* |
-probot.IProbotWebhooks (interface)
+### probot.IProbotWebhooks (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight on(name: str, handler: inflight (): void): void
| *No description* |
| inflight verifyAndReceive(props: VerifyAndReceieveProps): void
| *No description* |
-probot.IProbotAppCredentialsSupplier (interface)
+### probot.IProbotAppCredentialsSupplier (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -369,44 +391,54 @@ new(props: NgrokProps): Ngrok
| inflight getPrivateKey(): str
| *No description* |
| inflight getWebhookSecret(): str
| *No description* |
-ProbotAppProps (struct)
+### ProbotAppProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| credentialsSupplier
| IProbotAppCredentialsSupplier
| *No description* |
-simutils.ServiceProps (struct)
+### simutils.ServiceProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| cwd
| str?
| *No description* |
| env
| Map?
| *No description* |
-probot.Context (struct)
+### probot.Context (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| id
| str
| *No description* |
| octokit
| OctoKit
| *No description* |
-probot.ProbotInstance (struct)
+### probot.ProbotInstance (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| auth
| IProbotAuth
| *No description* |
| webhooks
| IProbotWebhooks
| *No description* |
-probot.PullRequestClosedContext (struct)
+### probot.PullRequestClosedContext (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -414,9 +446,11 @@ new(props: NgrokProps): Ngrok
| octokit
| OctoKit
| *No description* |
| payload
| PullRequestPayload
| *No description* |
-probot.PullRequestContext (struct)
+### probot.PullRequestContext (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -424,9 +458,11 @@ new(props: NgrokProps): Ngrok
| octokit
| OctoKit
| *No description* |
| payload
| PullRequestPayload
| *No description* |
-probot.PullRequestOpenedContext (struct)
+### probot.PullRequestOpenedContext (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -434,9 +470,11 @@ new(props: NgrokProps): Ngrok
| octokit
| OctoKit
| *No description* |
| payload
| PullRequestPayload
| *No description* |
-probot.PullRequestSyncContext (struct)
+### probot.PullRequestSyncContext (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -444,9 +482,11 @@ new(props: NgrokProps): Ngrok
| octokit
| OctoKit
| *No description* |
| payload
| PullRequestPayload
| *No description* |
-probot.PushContext (struct)
+### probot.PushContext (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -454,9 +494,11 @@ new(props: NgrokProps): Ngrok
| octokit
| OctoKit
| *No description* |
| payload
| PushPayload
| *No description* |
-probot.VerifyAndReceieveProps (struct)
+### probot.VerifyAndReceieveProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -465,9 +507,11 @@ new(props: NgrokProps): Ngrok
| payload
| str
| *No description* |
| signature
| str
| *No description* |
-probot.CreateAdapterOptions (struct)
+### probot.CreateAdapterOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -475,17 +519,21 @@ new(props: NgrokProps): Ngrok
| privateKey
| str
| *No description* |
| webhookSecret
| str
| *No description* |
-probot.ProbotAdapterProps (struct)
+### probot.ProbotAdapterProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| credentialsSupplier
| IProbotAppCredentialsSupplier
| *No description* |
-octokit.CompareCommitsProps (struct)
+### octokit.CompareCommitsProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -494,42 +542,52 @@ new(props: NgrokProps): Ngrok
| owner
| str
| *No description* |
| repo
| str
| *No description* |
-octokit.CompareCommitsResponse (struct)
+### octokit.CompareCommitsResponse (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| data
| CompareCommitsResponseData
| *No description* |
-octokit.CompareCommitsResponseCommit (struct)
+### octokit.CompareCommitsResponseCommit (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| sha
| str
| *No description* |
-octokit.CompareCommitsResponseData (struct)
+### octokit.CompareCommitsResponseData (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| commits
| Array
| *No description* |
-octokit.CompareCommitsResponseFile (struct)
+### octokit.CompareCommitsResponseFile (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| filaname
| str
| *No description* |
| sha
| str
| *No description* |
-octokit.GetCommitProps (struct)
+### octokit.GetCommitProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -537,25 +595,31 @@ new(props: NgrokProps): Ngrok
| ref
| str
| *No description* |
| repo
| str
| *No description* |
-octokit.GetCommitResponse (struct)
+### octokit.GetCommitResponse (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| data
| GetCommitResponseData
| *No description* |
-octokit.GetCommitResponseData (struct)
+### octokit.GetCommitResponseData (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| files
| Array?
| *No description* |
-octokit.GetCommitResponseFile (struct)
+### octokit.GetCommitResponseFile (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -563,9 +627,11 @@ new(props: NgrokProps): Ngrok
| sha
| str
| *No description* |
| status
| str
| *No description* |
-octokit.GetContentProps (struct)
+### octokit.GetContentProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -574,18 +640,22 @@ new(props: NgrokProps): Ngrok
| ref
| str?
| *No description* |
| repo
| str
| *No description* |
-octokit.GetContentResponse (struct)
+### octokit.GetContentResponse (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| data
| GetContentResponseData
| *No description* |
| status
| num
| *No description* |
-octokit.GetContentResponseData (struct)
+### octokit.GetContentResponseData (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -596,18 +666,22 @@ new(props: NgrokProps): Ngrok
| size
| num
| *No description* |
| type
| str
| *No description* |
-octokit.ListReposResponse (struct)
+### octokit.ListReposResponse (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| data
| Array
| *No description* |
| status
| num
| *No description* |
-octokit.OctoKit (struct)
+### octokit.OctoKit (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -617,9 +691,11 @@ new(props: NgrokProps): Ngrok
| pulls
| OctoKitPulls
| *No description* |
| repos
| OctoKitRepos
| *No description* |
-ngrok.NgrokProps (struct)
+### ngrok.NgrokProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/jwt.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/jwt.md
index 2a360116..dd77c6dd 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/jwt.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/jwt.md
@@ -37,9 +37,9 @@ test "will sign and verify" {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Util
@@ -49,19 +49,21 @@ This library is licensed under the [MIT License](./LICENSE).
- VerifyJwtOptions
- VerifyOptions
-Util (preflight class)
+### Util (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Util
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -69,17 +71,21 @@ new(): Util
| static inflight sign(data: Json, secret: str, options: SignOptions?): str
| *No description* |
| static inflight verify(token: str, options: VerifyOptions): Json
| *No description* |
-DecodeOptions (struct)
+### DecodeOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| complete
| bool?
| *No description* |
-SignOptions (struct)
+### SignOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -93,9 +99,11 @@ new(): Util
| notBefore
| duration?
| *No description* |
| subject
| str?
| *No description* |
-VerifyJwtOptions (struct)
+### VerifyJwtOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -109,9 +117,11 @@ new(): Util
| nonce
| str?
| *No description* |
| subject
| str?
| *No description* |
-VerifyOptions (struct)
+### VerifyOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/k8s.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/k8s.md
index 72830feb..a61e3108 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/k8s.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/k8s.md
@@ -135,24 +135,26 @@ deployment.exposeViaService(serviceType: k8s.ServiceType.LOAD_BALANCER);
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- ApiObject
- **Structs**
- ApiObjectProps
-ApiObject (preflight class)
+### ApiObject (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ApiObjectProps): ApiObject
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -163,7 +165,7 @@ new(props: ApiObjectProps): ApiObject
| metadata
| ApiObjectMetadataDefinition
| Metadata associated with this API object. |
| name
| str
| The name of the API object. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -173,9 +175,11 @@ new(props: ApiObjectProps): ApiObject
| static of(c: IConstruct): ApiObject
| Returns the `ApiObject` named `Resource` which is a child of the given construct. |
| toJson(): any
| Renders the object to Kubernetes JSON. |
-ApiObjectProps (struct)
+### ApiObjectProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/lock.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/lock.md
index 60d657dc..c43dbc14 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/lock.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/lock.md
@@ -84,28 +84,30 @@ test "count with expiry" {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Lock
- **Structs**
- LockAcquireOptions
-Lock (preflight class)
+### Lock (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Lock
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -114,9 +116,11 @@ new(): Lock
| inflight tryAcquire(id: str, options: LockAcquireOptions): bool
| *No description* |
| inflight tryRelease(id: str): bool
| *No description* |
-LockAcquireOptions (struct)
+### LockAcquireOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/messagefanout.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/messagefanout.md
index 5faeb6d4..c7cbb4c0 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/messagefanout.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/messagefanout.md
@@ -38,9 +38,9 @@ test "push a message to fanout" {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- MessageFanout
@@ -51,81 +51,91 @@ This library is licensed under the [MIT License](./LICENSE).
- **Structs**
- commons.MessageFanoutProps
-MessageFanout (preflight class)
+### MessageFanout (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): MessageFanout
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void
| *No description* |
| inflight publish(message: str): void
| *No description* |
-
+### platform.MessageFanout_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): MessageFanout_tfaws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void
| *No description* |
| inflight publish(message: str): void
| *No description* |
-
+### platform.MessageFanout_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): MessageFanout_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void
| *No description* |
| inflight publish(message: str): void
| *No description* |
-commons.IMessageFanout (interface)
+### commons.IMessageFanout (interface)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addConsumer(handler: inflight (str): void, props: MessageFanoutProps): void
| *No description* |
| inflight publish(message: str): void
| *No description* |
-commons.MessageFanoutProps (struct)
+### commons.MessageFanoutProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/momento.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/momento.md
index c96eb0a7..3a47ccec 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/momento.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/momento.md
@@ -46,9 +46,9 @@ See the [Momento documentation](https://docs.momentohq.com/cache/develop/authent
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Cache
@@ -59,47 +59,55 @@ This library is licensed under the [MIT License](./LICENSE).
- CacheProps
- CacheSetOptions
-Cache (preflight class)
+### Cache (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: CacheProps): Cache
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight get(key: str): str?
| *No description* |
| inflight set(key: str, value: str, opts: CacheSetOptions?): void
| *No description* |
-ICache (interface)
+### ICache (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight get(key: str, opts: CacheGetOptions?): str?
| Get a value from the cache. |
| inflight set(key: str, value: str, opts: CacheSetOptions?): void
| Set a value in the cache. |
-CacheGetOptions (struct)
+### CacheGetOptions (struct)
-Properties
+*No description*
+
+#### Properties
*No properties*
-CacheProps (struct)
+### CacheProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -107,9 +115,11 @@ new(props: CacheProps): Cache
| name
| str?
| The name of the cache. @default - a unique id will be generated |
| token
| Secret
| A secret containing the Momento API key to use for accessing the cache at runtime. |
-CacheSetOptions (struct)
+### CacheSetOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/ngrok.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/ngrok.md
index 1abe45df..db80b8b4 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/ngrok.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/ngrok.md
@@ -72,9 +72,9 @@ endpoint.
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Tunnel
@@ -83,41 +83,47 @@ This library is licensed under the [MIT License](./LICENSE).
- **Structs**
- NgrokProps
-Tunnel (preflight class)
+### Tunnel (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(url: str, props: NgrokProps?): Tunnel
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| onConnect(handler: inflight (str): void): void
| *No description* |
-OnConnectHandler (interface)
+### OnConnectHandler (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight handle(url: str): void
| *No description* |
-NgrokProps (struct)
+### NgrokProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/openai.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/openai.md
index acb15b56..b61114b0 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/openai.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/openai.md
@@ -86,9 +86,9 @@ Methods:
Licensed under the [MIT License](/LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- OpenAI
@@ -96,37 +96,43 @@ Licensed under the [MIT License](/LICENSE).
- CompletionParams
- OpenAIProps
-OpenAI (preflight class)
+### OpenAI (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: OpenAIProps?): OpenAI
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight createCompletion(prompt: str, params: CompletionParams?): str
| *No description* |
| static inflight createNewInflightClient(apiKey: str, org: str?): IClient
| *No description* |
-CompletionParams (struct)
+### CompletionParams (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| maxTokens
| num?
| *No description* |
| model
| str?
| *No description* |
-OpenAIProps (struct)
+### OpenAIProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/postgres.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/postgres.md
index c1efd8df..6ef97e7d 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/postgres.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/postgres.md
@@ -135,9 +135,9 @@ When you deploy Terraform that uses the `Database` class, you will need to have
Licensed under the [MIT License](../LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Database
@@ -149,69 +149,79 @@ Licensed under the [MIT License](../LICENSE).
- ConnectionOptions
- DatabaseProps
-Database (preflight class)
+### Database (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: DatabaseProps): Database
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| connection
| ConnectionOptions
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight connectionOptions(): ConnectionOptions
| *No description* |
| inflight query(query: str): Array
| *No description* |
-DatabaseRef (preflight class)
+### DatabaseRef (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): DatabaseRef
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight query(query: str): Array
| *No description* |
-IDatabase (interface)
+### IDatabase (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight connectionOptions(): ConnectionOptions?
| *No description* |
| inflight query(query: str): Array
| *No description* |
-AwsParameters (struct)
+### AwsParameters (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| postgresEngine
| str?
| *No description* |
-ConnectionOptions (struct)
+### ConnectionOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -222,9 +232,11 @@ new(): DatabaseRef
| ssl
| bool
| *No description* |
| user
| str
| *No description* |
-DatabaseProps (struct)
+### DatabaseProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/react.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/react.md
index cd4b01d7..f51871ea 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/react.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/react.md
@@ -106,9 +106,9 @@ export default App;
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Utils
@@ -121,19 +121,21 @@ This library is licensed under the [MIT License](./LICENSE).
- **Structs**
- AppProps
-Utils (preflight class)
+### Utils (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Utils
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -141,19 +143,21 @@ new(): Utils
| static execSync(command: str, env: MutMap, cwd: str): void
| *No description* |
| static inflight serveStaticFiles(path: str, port: num): inflight (): void
| *No description* |
-AppTfAws (preflight class)
+### AppTfAws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: AppProps): AppTfAws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -161,81 +165,91 @@ new(props: AppProps): AppTfAws
| getUrl(): str
| *No description* |
| addEnvironment(key: str, value: str): void
| *No description* |
-AppSim (preflight class)
+### AppSim (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: AppProps): AppSim
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| getUrl(): str
| *No description* |
| addEnvironment(key: str, value: str): void
| *No description* |
-App (preflight class)
+### App (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: AppProps): App
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addEnvironment(key: str, value: str): void
| *No description* |
-AppBase (preflight class)
+### AppBase (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: AppProps): AppBase
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addEnvironment(key: str, value: str): void
| *No description* |
-IApp (interface)
+### IApp (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| addEnvironment(key: str, value: str): void
| *No description* |
| getUrl(): str
| *No description* |
-AppProps (struct)
+### AppProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/redis.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/redis.md
index 3bd59229..98d694ff 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/redis.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/redis.md
@@ -67,9 +67,9 @@ Coming soon.
Licensed under the [MIT License](/LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Util
@@ -79,37 +79,41 @@ Licensed under the [MIT License](/LICENSE).
- IRedis
- IRedisClient
-Util (preflight class)
+### Util (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Util
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static inflight newRedisClient(url: str, redisPassword: str): IRedisClient
| *No description* |
-Redis (preflight class)
+### Redis (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Redis
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -122,19 +126,21 @@ new(): Redis
| inflight set(key: str, value: str): void?
| *No description* |
| inflight url(): str
| *No description* |
-Redis_sim (preflight class)
+### Redis_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Redis_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -147,13 +153,15 @@ new(): Redis_sim
| inflight set(key: str, value: str): void
| *No description* |
| inflight url(): str
| *No description* |
-IRedis (interface)
+### IRedis (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -166,13 +174,15 @@ new(): Redis_sim
| inflight set(key: str, value: str): void
| *No description* |
| inflight url(): str
| *No description* |
-IRedisClient (interface)
+### IRedisClient (interface)
+
+*No description*
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/sagemaker.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/sagemaker.md
index 4efe2464..73492083 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/sagemaker.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/sagemaker.md
@@ -78,9 +78,9 @@ new cloud.Function(handler, env: {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Endpoint
@@ -92,81 +92,91 @@ This library is licensed under the [MIT License](./LICENSE).
- InvocationOptions
- InvocationOutput
-Endpoint (preflight class)
+### Endpoint (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(endpointName: str, inferenceComponentName: str): Endpoint
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| endpointName
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput
| *No description* |
-SageMaker_tfaws (preflight class)
+### SageMaker_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(endpointName: str, inferenceComponentName: str): SageMaker_tfaws
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| endpointName
| str
| *No description* |
| inferenceComponentName
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput
| *No description* |
-SageMaker_sim (preflight class)
+### SageMaker_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(endpointName: str, inferenceName: str): SageMaker_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight invoke(body: Json, options: InvocationOptions?): InvocationOutput
| *No description* |
| setMockResponse(fn: inflight (Json, InvocationOptions?): InvocationOutput): void
| *No description* |
-ISageMaker (interface)
+### ISageMaker (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight invoke(body: Json, InvocationOptions: InvocationOptions?): InvocationOutput
| *No description* |
-InvocationOptions (struct)
+### InvocationOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -180,9 +190,11 @@ new(endpointName: str, inferenceName: str): SageMaker_sim
| TargetModel
| str?
| *No description* |
| TargetVariant
| str?
| *No description* |
-InvocationOutput (struct)
+### InvocationOutput (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/ses.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/ses.md
index 7c215d52..4a989775 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/ses.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/ses.md
@@ -32,9 +32,9 @@ let emailService = new ses.EmailService(emailIdentities: ["bot@wing.cloud"]);
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- EmailService_tfaws
@@ -55,94 +55,104 @@ This library is licensed under the [MIT License](./LICENSE).
- SendEmailOptions
- SendRawEmailOptions
-EmailService_tfaws (preflight class)
+### EmailService_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: EmailServiceProps): EmailService_tfaws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight sendEmail(options: SendEmailOptions): str?
| *No description* |
| inflight sendRawEmail(options: SendRawEmailOptions): str?
| *No description* |
-EmailService_sim (preflight class)
+### EmailService_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: EmailServiceProps): EmailService_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight sendEmail(options: SendEmailOptions): str?
| *No description* |
| inflight sendRawEmail(options: SendRawEmailOptions): str?
| *No description* |
-EmailService (preflight class)
+### EmailService (preflight class)
EmailService can used for defining and interacting with AWS SES.
When running the simulator in a non test environment, it will use the
actual cloud implementation.
-Constructor
+#### Constructor
-
+```
new(props: EmailServiceProps): EmailService
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight sendEmail(options: SendEmailOptions): str?
| *No description* |
| inflight sendRawEmail(options: SendRawEmailOptions): str?
| *No description* |
-IEmailService (interface)
+### IEmailService (interface)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight sendEmail(options: SendEmailOptions): str?
| *No description* |
| inflight sendRawEmail(options: SendRawEmailOptions): str?
| *No description* |
-Body (struct)
+### Body (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Html
| Content?
| *No description* |
| Text
| Content?
| *No description* |
-CloudWatchDestination (struct)
+### CloudWatchDestination (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -150,25 +160,31 @@ new(props: EmailServiceProps): EmailService
| dimensionName
| str
| *No description* |
| valueSource
| str
| *No description* |
-ConfigurationSet (struct)
+### ConfigurationSet (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| name
| str
| *No description* |
-Content (struct)
+### Content (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Data
| str?
| *No description* |
-Destination (struct)
+### Destination (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -176,9 +192,11 @@ new(props: EmailServiceProps): EmailService
| CcAddresses
| Array?
| *No description* |
| ToAddresses
| Array?
| *No description* |
-EmailServiceProps (struct)
+### EmailServiceProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -186,9 +204,11 @@ new(props: EmailServiceProps): EmailService
| emailIdentities
| Array?
| *No description* |
| eventDestination
| EventDestination?
| *No description* |
-EventDestination (struct)
+### EventDestination (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -196,26 +216,32 @@ new(props: EmailServiceProps): EmailService
| matchingTypes
| Array
| *No description* |
| name
| str
| *No description* |
-Message (struct)
+### Message (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Body
| Body?
| *No description* |
| Subject
| Content?
| *No description* |
-RawMessage (struct)
+### RawMessage (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| Data
| str
| *No description* |
-SendEmailOptions (struct)
+### SendEmailOptions (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -223,9 +249,11 @@ new(props: EmailServiceProps): EmailService
| Message
| Message?
| *No description* |
| Source
| str
| *No description* |
-SendRawEmailOptions (struct)
+### SendRawEmailOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/simtools.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/simtools.md
index ebacc545..41c00c23 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/simtools.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/simtools.md
@@ -60,26 +60,28 @@ npm i @winglibs/simtools
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Util
-
+### Util (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): Util
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/slack.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/slack.md
index a7a554a4..c34d0058 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/slack.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/slack.md
@@ -140,9 +140,9 @@ let postMessage = new cloud.Function(inflight () => {
If you prefer to use a channel ID over a channel name, you can find the channel ID by right-clicking on the channel name and select `View channel details`. The channel ID will be at the bottom of the popup modal.
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- SlackUtils
@@ -168,235 +168,247 @@ If you prefer to use a channel ID over a channel name, you can find the channel
- BlockType
- FieldType
-SlackUtils (preflight class)
+### SlackUtils (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): SlackUtils
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| static inflight post(body: Json, token: str): Json
| *No description* |
-Message (inflight class)
+### Message (inflight class)
Represents a Message block see: https://api.slack.com/block-kit
-Constructor
+#### Constructor
-
+```
new(): Message
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| sections
| MutArray
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight addSection(section: Section): void
| *No description* |
| inflight toJson(): Json
| Returns Json representation of message |
-App (preflight class)
+### App (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: AppProps): App
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| api
| Api
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight channel(id: str): Channel
| Retrieve a channel object from a channel Id or name |
| onEvent(eventName: str, handler: inflight (EventContext, Json): Json?): void
| Register an event handler (for available events see: https://api.slack.com/events) |
-Channel (inflight class)
+### Channel (inflight class)
Represents the context of a slack channel
-Constructor
+#### Constructor
-
+```
new(): Channel
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| id
| str
| The channel id |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight post(message: str): Json
| Post raw text to a channel |
| inflight postMessage(message: Message): Json
| Post a message block to a channel |
-EventContext (inflight class)
+### EventContext (inflight class)
Represents the context of an event callback
-Constructor
+#### Constructor
-
+```
new(): EventContext
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| channel
| Channel
| *No description* |
| thread
| Thread
| *No description* |
-Methods
+#### Methods
*No methods*
-EventContext_Mock (inflight class)
+### EventContext_Mock (inflight class)
Internally used for mocking event context
-Constructor
+#### Constructor
-
+```
new(): EventContext_Mock
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| channel
| Channel
| *No description* |
| thread
| Thread
| *No description* |
-Methods
+#### Methods
*No methods*
-MockChannel (inflight class)
+### MockChannel (inflight class)
Only used for internal testing
-Constructor
+#### Constructor
-
+```
new(): MockChannel
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| id
| str
| The channel id |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight post(message: str): Json
| *No description* |
| inflight postMessage(message: Message): Json
| *No description* |
-Thread (inflight class)
+### Thread (inflight class)
Represents the context of a slack thread
-Constructor
+#### Constructor
-
+```
new(): Thread
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| channel
| Channel
| The channel context |
| timestamp
| str
| The thread timestamp |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight post(message: str): Json
| Post raw text to a thread |
| inflight postMessage(message: Message): Json
| Post a message to a thread |
-IThread (interface)
+### IThread (interface)
The bahvioral interface of a thread
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight post(message: str): Json
| *No description* |
| inflight postMessage(message: Message): Json
| *No description* |
-Block (struct)
+### Block (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| fields
| Array
| *No description* |
| type
| BlockType
| *No description* |
-Field (struct)
+### Field (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| text
| str
| *No description* |
| type
| FieldType
| *No description* |
-Section (struct)
+### Section (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| fields
| Array
| *No description* |
-AppProps (struct)
+### AppProps (struct)
Properties for Slack bot
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| ignoreBots
| bool?
| Whether events from bot users should be ignored (default: true) |
| token
| Secret
| The token secret to use for the app |
-CallbackEvent (struct)
+### CallbackEvent (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -409,9 +421,11 @@ Properties for Slack bot
| type
| str
| *No description* |
| user
| str
| *No description* |
-MessageCallbackEvent (struct)
+### MessageCallbackEvent (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -425,17 +439,21 @@ Properties for Slack bot
| type
| str
| *No description* |
| user
| str
| *No description* |
-SlackEvent (struct)
+### SlackEvent (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| type
| str
| *No description* |
-VerificationEvent (struct)
+### VerificationEvent (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -443,17 +461,21 @@ Properties for Slack bot
| token
| str
| *No description* |
| type
| str
| *No description* |
-BlockType (enum)
+### BlockType (enum)
+
+*No description*
-Values
+#### Values
| **Name** | **Description** |
| --- | --- |
| section
| *No description* |
-FieldType (enum)
+### FieldType (enum)
+
+*No description*
-Values
+#### Values
| **Name** | **Description** |
| --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/sns.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/sns.md
index c767515b..1bcf3e6d 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/sns.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/sns.md
@@ -36,9 +36,9 @@ test "sending an SMS" {
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- MobileNotifications_sim
@@ -51,91 +51,101 @@ This library is licensed under the [MIT License](./LICENSE).
- PublishOptions
- PublishResult
-MobileNotifications_sim (preflight class)
+### MobileNotifications_sim (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(): MobileNotifications_sim
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight publish(options: PublishOptions): PublishResult
| *No description* |
-MobileNotifications (preflight class)
+### MobileNotifications (preflight class)
MobileNotifications is a client for interacting with SNS mobile service.
No cloud resources are created when using this class.
When running the simulator in a non test environment, it will use the
actual cloud implementation.
-Constructor
+#### Constructor
-
+```
new(): MobileNotifications
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight publish(options: PublishOptions): PublishResult
| *No description* |
-MobileNotifications_aws (preflight class)
+### MobileNotifications_aws (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(): MobileNotifications_aws
-
+```
-Properties
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight publish(options: PublishOptions): PublishResult
| *No description* |
-IMobileNotifications (interface)
+### IMobileNotifications (interface)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| inflight publish(options: PublishOptions): PublishResult
| *No description* |
-MessageAttributeValue (struct)
+### MessageAttributeValue (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DataType
| str?
| *No description* |
| StringValue
| str?
| *No description* |
-PublishOptions (struct)
+### PublishOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -145,9 +155,11 @@ new(): MobileNotifications_aws
| Subject
| str?
| *No description* |
| TopicArn
| str?
| *No description* |
-PublishResult (struct)
+### PublishResult (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/tf.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/tf.md
index a65d1b18..ada0c868 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/tf.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/tf.md
@@ -220,9 +220,9 @@ The above example will add a `provider` section to the output Terraform with a s
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Resource
@@ -232,15 +232,17 @@ This library is licensed under the [MIT License](./LICENSE).
- ResourceProps
- ProviderProps
-Resource (preflight class)
+### Resource (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ResourceProps): Resource
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -258,7 +260,7 @@ new(props: ResourceProps): Resource
| fqn
| str
| *No description* |
| friendlyUniqueId
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -287,15 +289,17 @@ new(props: ResourceProps): Resource
| overrideLogicalId(newLogicalId: str): void
| Overrides the auto-generated logical ID with a specific ID. |
| resetOverrideLogicalId(): void
| Resets a previously passed logical Id to use the auto-generated logical id again. |
-Provider (preflight class)
+### Provider (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ProviderProps): Provider
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -308,7 +312,7 @@ new(props: ProviderProps): Provider
| cdktfStack
| TerraformStack
| *No description* |
| friendlyUniqueId
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -321,15 +325,17 @@ new(props: ProviderProps): Provider
| overrideLogicalId(newLogicalId: str): void
| Overrides the auto-generated logical ID with a specific ID. |
| resetOverrideLogicalId(): void
| Resets a previously passed logical Id to use the auto-generated logical id again. |
-Element (preflight class)
+### Element (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(config: Json): Element
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -337,7 +343,7 @@ new(config: Json): Element
| fqn
| str
| *No description* |
| friendlyUniqueId
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -349,18 +355,22 @@ new(config: Json): Element
| toHclTerraform(): any
| *No description* |
| toMetadata(): any
| *No description* |
-ResourceProps (struct)
+### ResourceProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| attributes
| Json?
| *No description* |
| type
| str
| *No description* |
-ProviderProps (struct)
+### ProviderProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/tsoa.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/tsoa.md
index fec6aff2..265faa1d 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/tsoa.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/tsoa.md
@@ -74,9 +74,9 @@ public async getUser(
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Service_tfaws
@@ -90,93 +90,105 @@ This library is licensed under the [MIT License](./LICENSE).
- SpecProps
- StartServiceOptions
-Service_tfaws (preflight class)
+### Service_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ServiceProps): Service_tfaws
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| specFile
| str
| *No description* |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| lift(client: Resource, ops: LiftOptions): void
| *No description* |
-Service_sim (preflight class)
+### Service_sim (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: ServiceProps): Service_sim
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| specFile
| str
| *No description* |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| lift(client: Resource, ops: LiftOptions): void
| *No description* |
-Service (preflight class)
+### Service (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: ServiceProps): Service
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| specFile
| str
| *No description* |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| lift(client: Resource, ops: LiftOptions): void
| *No description* |
-IService (interface)
+### IService (interface)
-Properties
+*No description*
+
+#### Properties
*No properties*
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
| lift(client: Resource, ops: LiftOptions): void
| *No description* |
-LiftOptions (struct)
+### LiftOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| allow
| Array
| *No description* |
| id
| str
| *No description* |
-ServiceProps (struct)
+### ServiceProps (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
@@ -187,18 +199,22 @@ new(props: ServiceProps): Service
| spec
| SpecProps?
| *No description* |
| watchDir
| str?
| *No description* |
-SpecProps (struct)
+### SpecProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| outputDirectory
| str?
| *No description* |
| specVersion
| num?
| *No description* |
-StartServiceOptions (struct)
+### StartServiceOptions (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/vite.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/vite.md
index 3c55a991..c60444a4 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/vite.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/vite.md
@@ -47,9 +47,9 @@ let url = website.url;
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- Vite
@@ -58,63 +58,71 @@ This library is licensed under the [MIT License](./LICENSE).
- **Structs**
- ViteProps
-Vite (preflight class)
+### Vite (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ViteProps): Vite
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
*No methods*
-Vite_tf_aws (preflight class)
+### Vite_tf_aws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: ViteProps): Vite_tf_aws
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
*No methods*
-Vite_sim (preflight class)
+### Vite_sim (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: ViteProps): Vite_sim
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
*No methods*
-ViteProps (struct)
+### ViteProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
diff --git a/versioned_docs/version-latest/04-winglibs/05-winglibs/websockets.md b/versioned_docs/version-latest/04-winglibs/05-winglibs/websockets.md
index 617d9a9b..c83920fa 100644
--- a/versioned_docs/version-latest/04-winglibs/05-winglibs/websockets.md
+++ b/versioned_docs/version-latest/04-winglibs/05-winglibs/websockets.md
@@ -90,9 +90,9 @@ To compile to `awscdk`, we need to import the `@winglang/platform-awscdk`.
This library is licensed under the [MIT License](./LICENSE).
---
-API Reference
+## API Reference
-Table of Contents
+### Table of Contents
- **Classes**
- WebSocket
@@ -108,21 +108,23 @@ This library is licensed under the [MIT License](./LICENSE).
- platform.aws.WebSocketAwsResponse
- commons.WebSocketProps
-WebSocket (preflight class)
+### WebSocket (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: WebSocketProps): WebSocket
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -131,21 +133,23 @@ new(props: WebSocketProps): WebSocket
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-
+### platform.WebSocket_tfaws (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: WebSocketProps): WebSocket_tfaws
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -155,21 +159,23 @@ new(props: WebSocketProps): WebSocket_tfaws
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-
+### platform.WebSocket_sim (preflight class)
+
+*No description*
-Constructor
+#### Constructor
-
+```
new(props: WebSocketProps): WebSocket_sim
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -178,21 +184,23 @@ new(props: WebSocketProps): WebSocket_sim
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-
+### platform.WebSocket_awscdk (preflight class)
-Constructor
+*No description*
-
+#### Constructor
+
+```
new(props: WebSocketProps): WebSocket_awscdk
-
+```
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| url
| str
| *No description* |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -202,15 +210,17 @@ new(props: WebSocketProps): WebSocket_awscdk
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-
+### platform.aws.IAwsWebSocket (interface)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -220,15 +230,17 @@ new(props: WebSocketProps): WebSocket_awscdk
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-commons.IWebSocket (interface)
+### commons.IWebSocket (interface)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node
| Node
| The tree node. |
-Methods
+#### Methods
| **Signature** | **Description** |
| --- | --- |
@@ -237,36 +249,44 @@ new(props: WebSocketProps): WebSocket_awscdk
| onMessage(handler: inflight (str, str): void): void
| *No description* |
| inflight sendMessage(connectionId: str, message: str): void
| *No description* |
-
+### platform.aws.WebSocketAwsRequest (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| body
| str
| *No description* |
| requestContext
| WebSocketAwsRequestContext
| *No description* |
-platform.aws.WebSocketAwsRequestContext (struct)
+### platform.aws.WebSocketAwsRequestContext (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| connectionId
| str
| *No description* |
| routeKey
| str
| *No description* |
-
+### platform.aws.WebSocketAwsResponse (struct)
-Properties
+*No description*
+
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| body
| str?
| *No description* |
| statusCode
| num
| *No description* |
-commons.WebSocketProps (struct)
+### commons.WebSocketProps (struct)
+
+*No description*
-Properties
+#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |