Skip to content

Update SDK Documentation #72

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

Closed
caidobot wants to merge 1 commit into from
Closed

Update SDK Documentation #72

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
178 changes: 115 additions & 63 deletions src/reference/sdks/frontend/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -601,43 +601,11 @@ The context for a command that is executed on a request pane.

##### request

> **request**: `object`
> **request**: [`RequestDraft`](index.md#requestdraft) \| [`RequestFull`](index.md#requestfull)

The request that is currently open in the request pane.
If the request has not yet been saved in the database, the id will be undefined.

###### request.host

> **host**: `string`

###### request.id

> **id**: [`ID`](index.md#id-3) \| `undefined`

###### request.isTls

> **isTls**: `boolean`

###### request.path

> **path**: `string`

###### request.port

> **port**: `number`

###### request.query

> **query**: `string`

###### request.raw

> **raw**: `string`

###### request.streamId?

> `optional` **streamId**: [`ID`](index.md#id-3)

##### selection

> **selection**: `string`
Expand All @@ -660,7 +628,7 @@ The context for a command that is executed on a row in the request table.

##### requests

> **requests**: `object`[]
> **requests**: [`RequestMeta`](index.md#requestmeta)[]

The requests that are selected in the request table.

Expand All @@ -680,38 +648,10 @@ The context for a command that is executed on a response pane.

##### request

> **request**: `object`
> **request**: [`RequestMeta`](index.md#requestmeta)

The request that is associated with the response.

###### request.host

> **host**: `string`

###### request.id

> **id**: [`ID`](index.md#id-3)

###### request.isTls

> **isTls**: `boolean`

###### request.path

> **path**: `string`

###### request.port

> **port**: `number`

###### request.query

> **query**: `string`

###### request.streamId?

> `optional` **streamId**: [`ID`](index.md#id-3)

##### response

> **response**: `object`
Expand Down Expand Up @@ -1864,6 +1804,38 @@ Utilities to interact with the Search page.

#### Type declaration

##### addRequestEditorExtension()

> **addRequestEditorExtension**: (`extension`: `Extension`) => `void`

Add an extension to the request editor.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `extension` | `Extension` | The extension to add. |

###### Returns

`void`

##### addRequestViewMode()

> **addRequestViewMode**: (`options`: [`RequestViewModeOptions`](index.md#requestviewmodeoptions)) => `void`

Add a custom request view mode.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options` | [`RequestViewModeOptions`](index.md#requestviewmodeoptions) | The view mode options. |

###### Returns

`void`

##### getQuery()

> **getQuery**: () => [`HTTPQL`](index.md#httpql)
Expand Down Expand Up @@ -2823,6 +2795,24 @@ A section for the response first line.

## Other

### As\<TType\>

> **As**\<`TType`\>: `object`

#### Type Parameters

| Type Parameter |
| ------ |
| `TType` *extends* `string` |

#### Type declaration

##### type

> **type**: `TType`

***

### ButtonSlotContent

> **ButtonSlotContent**: [`DefineSlotContent`](index.md#defineslotcontentttype-p)\<`"Button"`, \{ `icon`: `string`; `label`: `string`; `onClick`: () => `void`; \}\>
Expand Down Expand Up @@ -3720,6 +3710,18 @@ Stop the listener.

***

### Prettify\<T\>

> **Prettify**\<`T`\>: `{ [K in keyof T]: T[K] }` & `object`

#### Type Parameters

| Type Parameter |
| ------ |
| `T` |

***

### PromisifiedReturnType\<T\>

> **PromisifiedReturnType**\<`T`\>: `ReturnType`\<`T`\> *extends* `Promise`\<infer U\> ? `Promise`\<`U`\> : `Promise`\<`ReturnType`\<`T`\>\>
Expand Down Expand Up @@ -3758,6 +3760,24 @@ Stop the listener.

***

### RequestDraft

> **RequestDraft**: [`Prettify`](index.md#prettifyt)\<[`As`](index.md#asttype)\<`"RequestDraft"`\> & `object`\>

***

### RequestFull

> **RequestFull**: [`Prettify`](index.md#prettifyt)\<[`As`](index.md#asttype)\<`"RequestFull"`\> & `object`\>

***

### RequestMeta

> **RequestMeta**: [`Prettify`](index.md#prettifyt)\<[`As`](index.md#asttype)\<`"RequestMeta"`\> & `object`\>

***

### RequestViewModeOptions

> **RequestViewModeOptions**: `object`
Expand Down Expand Up @@ -3836,6 +3856,38 @@ Utilities to interact with the Sitemap page.

#### Type declaration

##### addRequestEditorExtension()

> **addRequestEditorExtension**: (`extension`: `Extension`) => `void`

Add an extension to the request editor.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `extension` | `Extension` | The extension to add. |

###### Returns

`void`

##### addRequestViewMode()

> **addRequestViewMode**: (`options`: [`RequestViewModeOptions`](index.md#requestviewmodeoptions)) => `void`

Add a custom request view mode.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `options` | [`RequestViewModeOptions`](index.md#requestviewmodeoptions) | The view mode options. |

###### Returns

`void`

##### getScopeId()

> **getScopeId**: () => [`ID`](index.md#id-3) \| `undefined`
Expand Down