Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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
12 changes: 12 additions & 0 deletions src/reference/sdks/frontend/ai.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,18 @@ Settings for AI language model.

#### Properties

##### capabilities?

> `optional` **capabilities**: `object`

###### reasoning

> **reasoning**: `boolean`

###### structured\_output

> **structured\_output**: `boolean`

##### reasoning?

> `optional` **reasoning**: [`AIReasoningSettings`](#aireasoningsettings)
Expand Down
57 changes: 57 additions & 0 deletions src/reference/sdks/frontend/filters.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Filters

### CurrentFilterChangeEvent

> **CurrentFilterChangeEvent** = `object`

Event fired when the current filter changes.

#### Properties

##### filterId

> **filterId**: [`ID`](utils.md#id) \| `undefined`

The ID of the newly selected filter, or undefined if no filter is selected.

***

### Filter

> **Filter** = `object`
Expand Down Expand Up @@ -130,6 +146,47 @@ Gets all filters.

The filters.

##### getCurrentFilter()

> **getCurrentFilter**: () => [`Filter`](#filter) \| `undefined`

Get the currently selected filter.

###### Returns

[`Filter`](#filter) \| `undefined`

The currently selected filter, or undefined if no filter is selected.

##### onCurrentFilterChange()

> **onCurrentFilterChange**: (`callback`: (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)

Subscribe to current filter changes.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback` | (`event`: [`CurrentFilterChangeEvent`](#currentfilterchangeevent)) => `void` | The callback to call when the selected filter changes. |

###### Returns

[`ListenerHandle`](utils.md#listenerhandle)

An object with a `stop` method that can be called to stop listening to filter changes.

###### Example

```ts
const handler = sdk.filters.onCurrentFilterChange((event) => {
console.log(`Filter ${event.filterId} got selected!`);
});

// Later, stop listening
handler.stop();
```

##### update()

> **update**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Filter`](#filter)\>
Expand Down
57 changes: 57 additions & 0 deletions src/reference/sdks/frontend/match-and-replace.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Match and Replace

### CurrentMatchReplaceRuleChangeEvent

> **CurrentMatchReplaceRuleChangeEvent** = `object`

Event fired when the current match and replace rule changes.

#### Properties

##### ruleId

> **ruleId**: [`ID`](utils.md#id) \| `undefined`

The ID of the newly selected rule, or undefined if no rule is selected.

***

### MatchReplaceCollection

> **MatchReplaceCollection** = `object`
Expand Down Expand Up @@ -712,6 +728,18 @@ Get all collections.

[`MatchReplaceCollection`](#matchreplacecollection)[]

##### getCurrentRule()

> **getCurrentRule**: () => [`MatchReplaceRule`](#matchreplacerule) \| `undefined`

Get the currently selected rule.

###### Returns

[`MatchReplaceRule`](#matchreplacerule) \| `undefined`

The currently selected rule, or undefined if no rule is selected.

##### getRules()

> **getRules**: () => [`MatchReplaceRule`](#matchreplacerule)[]
Expand All @@ -724,6 +752,35 @@ Get all rules.

All rules.

##### onCurrentRuleChange()

> **onCurrentRuleChange**: (`callback`: (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)

Subscribe to current rule changes.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback` | (`event`: [`CurrentMatchReplaceRuleChangeEvent`](#currentmatchreplacerulechangeevent)) => `void` | The callback to call when the selected rule changes. |

###### Returns

[`ListenerHandle`](utils.md#listenerhandle)

An object with a `stop` method that can be called to stop listening to rule changes.

###### Example

```ts
const handler = sdk.matchReplace.onCurrentRuleChange((event) => {
console.log(`Rule ${event.ruleId} got selected!`);
});

// Later, stop listening
handler.stop();
```

##### selectRule()

> **selectRule**: (`id`: [`ID`](utils.md#id) \| `undefined`) => `void`
Expand Down
57 changes: 57 additions & 0 deletions src/reference/sdks/frontend/scopes.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,21 @@
# Scopes

### CurrentScopeChangeEvent

> **CurrentScopeChangeEvent** = `object`

Event fired when the current scope changes.

#### Properties

##### scopeId

> **scopeId**: [`ID`](utils.md#id) \| `undefined`

The ID of the newly selected scope, or undefined if no scope is selected.

***

### Scope

> **Scope** = `object`
Expand Down Expand Up @@ -129,6 +145,18 @@ Delete a scope.

Whether the scope was deleted.

##### getCurrentScope()

> **getCurrentScope**: () => [`Scope`](#scope) \| `undefined`

Get the currently selected scope.

###### Returns

[`Scope`](#scope) \| `undefined`

The currently selected scope, or undefined if no scope is selected.

##### getScopes()

> **getScopes**: () => [`Scope`](#scope)[]
Expand All @@ -141,6 +169,35 @@ Get all scopes.

A list of scopes.

##### onCurrentScopeChange()

> **onCurrentScopeChange**: (`callback`: (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void`) => [`ListenerHandle`](utils.md#listenerhandle)

Subscribe to current scope changes.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `callback` | (`event`: [`CurrentScopeChangeEvent`](#currentscopechangeevent)) => `void` | The callback to call when the selected scope changes. |

###### Returns

[`ListenerHandle`](utils.md#listenerhandle)

An object with a `stop` method that can be called to stop listening to scope changes.

###### Example

```ts
const handler = sdk.scopes.onCurrentScopeChange((event) => {
console.log(`Scope ${event.scopeId} got selected!`);
});

// Later, stop listening
handler.stop();
```

##### updateScope()

> **updateScope**: (`id`: [`ID`](utils.md#id), `options`: `object`) => `Promise`\<[`Scope`](#scope) \| `undefined`\>
Expand Down