Skip to content

Commit 6f69ab1

Browse files
authored
Update SDK Documentation (#46)
1 parent 747cbca commit 6f69ab1

File tree

3 files changed

+57
-3
lines changed

3 files changed

+57
-3
lines changed

src/reference/sdks/backend/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2369,6 +2369,13 @@ Input for the `setVar` of [EnvironmentSDK](index.md#environmentsdk).
23692369

23702370
#### Type declaration
23712371

2372+
##### env?
2373+
2374+
> `optional` **env**: `string`
2375+
2376+
The `name` of the Environment to set the variable on.
2377+
This will take precedence over the `global` flag if provided.
2378+
23722379
##### global
23732380

23742381
> **global**: `boolean`

src/reference/sdks/frontend/index.md

Lines changed: 43 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -628,6 +628,10 @@ If the request has not yet been saved in the database, the id will be undefined.
628628

629629
> **raw**: `string`
630630
631+
###### request.streamId?
632+
633+
> `optional` **streamId**: [`ID`](index.md#id-3)
634+
631635
##### selection
632636

633637
> **selection**: `string`
@@ -698,6 +702,10 @@ The request that is associated with the response.
698702

699703
> **query**: `string`
700704
705+
###### request.streamId?
706+
707+
> `optional` **streamId**: [`ID`](index.md#id-3)
708+
701709
##### response
702710

703711
> **response**: `object`
@@ -751,11 +759,11 @@ Register a command.
751759
| Parameter | Type | Description |
752760
| ------ | ------ | ------ |
753761
| `id` | [`CommandID`](index.md#commandid) | The id of the command. |
754-
| `options` | \{ `group`: `string`; `name`: `string`; `run`: (`context`: [`CommandContext`](index.md#commandcontext)) => `void`; `when`: (`context`: [`CommandContext`](index.md#commandcontext)) => `boolean`; \} | Options for the command. |
762+
| `options` | \{ `group`: `string`; `name`: `string`; `run`: (`context`: [`CommandContext`](index.md#commandcontext)) => `Promise`\<`void`\> \| `void`; `when`: (`context`: [`CommandContext`](index.md#commandcontext)) => `Promise`\<`boolean`\> \| `boolean`; \} | Options for the command. |
755763
| `options.group`? | `string` | The group this command belongs to. |
756764
| `options.name` | `string` | The name of the command. |
757-
| `options.run` | (`context`: [`CommandContext`](index.md#commandcontext)) => `void` | The function to run when the command is executed. |
758-
| `options.when`? | (`context`: [`CommandContext`](index.md#commandcontext)) => `boolean` | A function to determine if the command is available. |
765+
| `options.run` | (`context`: [`CommandContext`](index.md#commandcontext)) => `Promise`\<`void`\> \| `void` | The function to run when the command is executed. |
766+
| `options.when`? | (`context`: [`CommandContext`](index.md#commandcontext)) => `Promise`\<`boolean`\> \| `boolean` | A function to determine if the command is available. |
759767

760768
###### Returns
761769

@@ -1380,6 +1388,38 @@ Utilities to interact with the HTTP History page.
13801388

13811389
#### Type declaration
13821390

1391+
##### addRequestEditorExtension()
1392+
1393+
> **addRequestEditorExtension**: (`extension`: `Extension`) => `void`
1394+
1395+
Add an extension to the request editor.
1396+
1397+
###### Parameters
1398+
1399+
| Parameter | Type | Description |
1400+
| ------ | ------ | ------ |
1401+
| `extension` | `Extension` | The extension to add. |
1402+
1403+
###### Returns
1404+
1405+
`void`
1406+
1407+
##### addResponseEditorExtension()
1408+
1409+
> **addResponseEditorExtension**: (`extension`: `Extension`) => `void`
1410+
1411+
Add an extension to the response editor.
1412+
1413+
###### Parameters
1414+
1415+
| Parameter | Type | Description |
1416+
| ------ | ------ | ------ |
1417+
| `extension` | `Extension` | The extension to add. |
1418+
1419+
###### Returns
1420+
1421+
`void`
1422+
13831423
##### getQuery()
13841424

13851425
> **getQuery**: () => [`HTTPQL`](index.md#httpql)

src/reference/sdks/workflow/index.md

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2107,6 +2107,13 @@ Input for the `setVar` of [EnvironmentSDK](index.md#environmentsdk).
21072107

21082108
#### Type declaration
21092109

2110+
##### env?
2111+
2112+
> `optional` **env**: `string`
2113+
2114+
The `name` of the Environment to set the variable on.
2115+
This will take precedence over the `global` flag if provided.
2116+
21102117
##### global
21112118

21122119
> **global**: `boolean`

0 commit comments

Comments
 (0)