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.

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

Documentation and Code Corrections: Grammar, Typo, and Formatting Updates #3705

Closed
wants to merge 6 commits into from
Closed
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
13 changes: 6 additions & 7 deletions docs/api/classes/FsCacheAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -28,15 +28,15 @@

### get()

> **get**(`key`): `Promise`\<`string`\>
> **get**(`key`): `Promise<string>`

#### Parameters

• **key**: `string`

#### Returns

`Promise`\<`string`\>
`Promise<string>`

#### Implementation of

Expand All @@ -50,7 +50,7 @@

### set()

> **set**(`key`, `value`): `Promise`\<`void`\>
> **set**(`key`, `value`): `Promise<void>`

#### Parameters

Expand All @@ -60,8 +60,7 @@

#### Returns

`Promise`\<`void`\>

`Promise<void>`
#### Implementation of

[`ICacheAdapter`](../interfaces/ICacheAdapter.md).[`set`](../interfaces/ICacheAdapter.md#set)
Expand All @@ -74,15 +73,15 @@

### delete()

> **delete**(`key`): `Promise`\<`void`\>
> **delete**(`key`): `Promise<void>`

#### Parameters

• **key**: `string`

#### Returns

`Promise`\<`void`\>
`Promise<void>`

#### Implementation of

Expand Down
14 changes: 7 additions & 7 deletions docs/api/classes/MemoryCacheAdapter.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@

#### Parameters

• **initalData?**: `Map`\<`string`, `string`\>
• **initialData?**: `Map<string, string>`

#### Returns

Expand All @@ -28,7 +28,7 @@

### data

> **data**: `Map`\<`string`, `string`\>
> **data**: `Map<string, string>`

#### Defined in

Expand All @@ -38,15 +38,15 @@

### get()

> **get**(`key`): `Promise`\<`string`\>
> **get**(`key`): `Promise<string>`

#### Parameters

• **key**: `string`

#### Returns

`Promise`\<`string`\>
`Promise<string>`

#### Implementation of

Expand All @@ -70,7 +70,7 @@

#### Returns

`Promise`\<`void`\>
`Promise<void>`

#### Implementation of

Expand All @@ -84,15 +84,15 @@

### delete()

> **delete**(`key`): `Promise`\<`void`\>
> **delete**(`key`): `Promise<void>`

#### Parameters

• **key**: `string`

#### Returns

`Promise`\<`void`\>
`Promise<void>`

#### Implementation of

Expand Down
7 changes: 3 additions & 4 deletions docs/api/functions/trimTokens.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

# Function: trimTokens()

> **trimTokens**(`context`, `maxTokens`, `runtime`): `Promise`\<`string`\>
> **trimTokens**(`context`, `maxTokens`, `runtime`): `Promise<string>`

Trims the provided text context to a specified token limit using a tokenizer model and type.

Expand All @@ -26,7 +26,7 @@ The runtime interface providing tokenizer settings.

## Returns

`Promise`\<`string`\>
`Promise<string>`

A promise that resolves to the trimmed text.

Expand All @@ -38,8 +38,7 @@ trimTokens

## Throws

Throws an error if the runtime settings are invalid or missing required fields.

Throws an error if runtime settings are invalid or missing fields.
## Example

```ts
Expand Down
Loading