Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

chore: update docs #317

Merged
merged 1 commit into from
Sep 4, 2024
Merged

chore: update docs #317

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 18 additions & 14 deletions bedrock/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,44 +1,48 @@
<h2>API Reference</h2>
## API Reference

<h3>Table of Contents</h3>
### Table of Contents

- **Classes**
- <a href="#@winglibs/bedrock.JokeMaker">JokeMaker</a>
- <a href="#@winglibs/bedrock.Model">Model</a>

<h3 id="@winglibs/bedrock.JokeMaker">JokeMaker (preflight class)</h3>
### JokeMaker (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.JokeMaker"></a>

<h4>Constructor</h4>
*No description*

<pre>
#### Constructor

```
new(): JokeMaker
</pre>
```

<h4>Properties</h4>
#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

| **Signature** | **Description** |
| --- | --- |
| <code>inflight makeJoke(topic: str): str</code> | *No description* |

<h3 id="@winglibs/bedrock.Model">Model (preflight class)</h3>
### Model (preflight class) <a class="wing-docs-anchor" id="@winglibs/bedrock.Model"></a>

*No description*

<h4>Constructor</h4>
#### Constructor

<pre>
```
new(modelId: str): Model
</pre>
```

<h4>Properties</h4>
#### Properties

| **Name** | **Type** | **Description** |
| --- | --- | --- |
| <code>modelId</code> | <code>str</code> | *No description* |

<h4>Methods</h4>
#### Methods

| **Signature** | **Description** |
| --- | --- |
Expand Down
4 changes: 2 additions & 2 deletions bedrock/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion bedrock/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"name": "@winglibs/bedrock",
"description": "A Wing library for Amazon Bedrock",
"version": "0.1.1",
"version": "0.1.2",
"author": {
"name": "Eyal Keren",
"email": "eyalk@wing.cloud"
Expand Down
80 changes: 47 additions & 33 deletions budget/API.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
<h2>API Reference</h2>
## API Reference

<h3>Table of Contents</h3>
### Table of Contents

- **Classes**
- <a href="#@winglibs/budget.Alert">Alert</a>
Expand All @@ -14,85 +14,97 @@
- **Enums**
- <a href="#@winglibs/budget.TimeUnit">TimeUnit</a>

<h3 id="@winglibs/budget.Alert">Alert (preflight class)</h3>
### Alert (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Alert"></a>

<h4>Constructor</h4>
*No description*

<pre>
#### Constructor

```
new(props: AlertProps): Alert
</pre>
```

<h4>Properties</h4>
#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

*No methods*

<h3 id="@winglibs/budget.AlertTfAws">AlertTfAws (preflight class)</h3>
### AlertTfAws (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertTfAws"></a>

*No description*

<h4>Constructor</h4>
#### Constructor

<pre>
```
new(props: AlertProps): AlertTfAws
</pre>
```

<h4>Properties</h4>
#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

*No methods*

<h3 id="@winglibs/budget.AlertSim">AlertSim (preflight class)</h3>
### AlertSim (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.AlertSim"></a>

<h4>Constructor</h4>
*No description*

<pre>
#### Constructor

```
new(props: AlertProps): AlertSim
</pre>
```

<h4>Properties</h4>
#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

*No methods*

<h3 id="@winglibs/budget.Util">Util (preflight class)</h3>
### Util (preflight class) <a class="wing-docs-anchor" id="@winglibs/budget.Util"></a>

*No description*

<h4>Constructor</h4>
#### Constructor

<pre>
```
new(): Util
</pre>
```

<h4>Properties</h4>
#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

| **Signature** | **Description** |
| --- | --- |
| <code>static timeUnitToStr(timeUnit: TimeUnit): str</code> | *No description* |

<h3 id="@winglibs/budget.IAlert">IAlert (interface)</h3>
### IAlert (interface) <a class="wing-docs-anchor" id="@winglibs/budget.IAlert"></a>

<h4>Properties</h4>
*No description*

#### Properties

*No properties*

<h4>Methods</h4>
#### Methods

*No methods*

<h3 id="@winglibs/budget.AlertProps">AlertProps (struct)</h3>
### AlertProps (struct) <a class="wing-docs-anchor" id="@winglibs/budget.AlertProps"></a>

*No description*

<h4>Properties</h4>
#### Properties

| **Name** | **Type** | **Description** |
| --- | --- | --- |
Expand All @@ -101,9 +113,11 @@ new(): Util
| <code>name</code> | <code>str</code> | *No description* |
| <code>timeUnit</code> | <code>TimeUnit?</code> | *No description* |

<h3 id="@winglibs/budget.TimeUnit">TimeUnit (enum)</h3>
### TimeUnit (enum) <a class="wing-docs-anchor" id="@winglibs/budget.TimeUnit"></a>

*No description*

<h4>Values</h4>
#### Values

| **Name** | **Description** |
| --- | --- |
Expand Down
4 changes: 2 additions & 2 deletions budget/package-lock.json
View file
Open in desktop

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion budget/package.json
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"name": "@winglibs/budget",
"version": "0.1.6",
"version": "0.1.7",
"description": "AWS Budget",
"keywords": [
"AWS",
Expand Down
Loading
Loading