> ## Documentation Index
> Fetch the complete documentation index at: https://botmesh.afaya.com.co/llms.txt
> Use this file to discover all available pages before exploring further.

# CrashableProvider

> Class exported by @botmesh/core/testing.

Defined in: [testing/crash.ts:136](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/crash.ts#L136)

A MockProvider whose sends hang once `crash()` was called (or once `backend` crashed).

## Extends

* [`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider)

## Constructors

### Constructor

```ts theme={null}
new CrashableProvider(backend?): CrashableProvider;
```

Defined in: [testing/crash.ts:138](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/crash.ts#L138)

#### Parameters

| Parameter | Type |
| - | - |
| `backend?` | `Pick`\<[`CrashableBackend`](https://botmesh.afaya.com.co/api/core/testing/interfaces/CrashableBackend), `"crashed"`> |

#### Returns

`CrashableProvider`

#### Overrides

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`constructor`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#constructor)

## Properties

### id

```ts theme={null}
readonly id: "mock" = 'mock';
```

Defined in: [testing/MockProvider.ts:232](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L232)

Stable transport tag (e.g. 'baileys', 'telegram') — used to namespace
conversation keys if one Bot ever runs multiple providers concurrently.

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`id`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#id)

***

### capabilities

```ts theme={null}
readonly capabilities: ProviderCapabilities;
```

Defined in: [testing/MockProvider.ts:233](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L233)

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`capabilities`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#capabilities)

***

### selfId

```ts theme={null}
selfId: string | null = null;
```

Defined in: [testing/MockProvider.ts:234](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L234)

The bot's own user id once connected (for group mention matching). Optional.

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`selfId`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#selfid)

***

### outbox

```ts theme={null}
outbox: MockOutgoing[] = [];
```

Defined in: [testing/MockProvider.ts:236](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L236)

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`outbox`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#outbox)

***

### journal

```ts theme={null}
journal: MockJournalEntry[] = [];
```

Defined in: [testing/MockProvider.ts:241](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L241)

Chronological journal of inbound messages/interactions (as emitted, before any chaos
wrapper) and of every `send` with the `ref` it returned. Bounded by `maxJournal`.

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`journal`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#journal)

***

### edits

```ts theme={null}
edits: MockEdit[] = [];
```

Defined in: [testing/MockProvider.ts:243](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L243)

Edits recorded by [editMessage](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#editmessage) (enabled by `streaming` `'edit'`/`'draft'` or `supports.edit`).

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`edits`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#edits)

***

### drafts

```ts theme={null}
drafts: MockDraft[] = [];
```

Defined in: [testing/MockProvider.ts:245](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L245)

Draft previews recorded by [sendDraft](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#senddraft) (enabled by `streaming: 'draft'` or `supports.drafts`).

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`drafts`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#drafts)

***

### deleted

```ts theme={null}
deleted: MessageRef[] = [];
```

Defined in: [testing/MockProvider.ts:247](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L247)

Messages deleted through [deleteMessage](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#deletemessage) (enabled by `streaming` not `'none'` or `supports.delete`).

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`deleted`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#deleted)

***

### acks

```ts theme={null}
acks: object[] = [];
```

Defined in: [testing/MockProvider.ts:249](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L249)

Interaction acks recorded by [acknowledgeInteraction](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#acknowledgeinteraction), in order.

#### interactionId

```ts theme={null}
interactionId: string;
```

#### opts?

```ts theme={null}
opts?: object;
```

##### opts.text?

```ts theme={null}
text?: string;
```

##### opts.defer?

```ts theme={null}
defer?: boolean;
```

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`acks`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#acks)

***

### textFormatFor?

```ts theme={null}
textFormatFor?: (chatId) => TextFormat | undefined;
```

Defined in: [testing/MockProvider.ts:251](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L251)

Per-chat text format — present only when [MockProviderOptions.textFormatFor](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockProviderOptions.md#textformatfor) is given.

#### Parameters

| Parameter | Type |
| - | - |
| `chatId` | `string` |

#### Returns

[`TextFormat`](https://botmesh.afaya.com.co/api/core/type-aliases/TextFormat) | `undefined`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`textFormatFor`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#textformatfor)

***

### maxJournal

```ts theme={null}
readonly maxJournal: number;
```

Defined in: [testing/MockProvider.ts:253](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L253)

Journal cap ([MockProviderOptions.maxJournal](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockProviderOptions.md#maxjournal)).

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`maxJournal`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#maxjournal)

***

### starts

```ts theme={null}
starts: number = 0;
```

Defined in: [testing/MockProvider.ts:320](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L320)

`start()` calls so far.

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`starts`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#starts)

***

### stops

```ts theme={null}
stops: number = 0;
```

Defined in: [testing/MockProvider.ts:322](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L322)

`stop()` calls so far.

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`stops`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#stops)

## Methods

### editMessage()

```ts theme={null}
editMessage(ref, content): Promise<SendResult<unknown>>;
```

Defined in: [testing/MockProvider.ts:289](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L289)

Records the edit in [edits](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#edits). Hidden (`undefined`) unless enabled — see [MockProviderOptions.supports](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockProviderOptions.md#supports).

#### Parameters

| Parameter | Type |
| - | - |
| `ref` | [`MessageRef`](https://botmesh.afaya.com.co/api/core/interfaces/MessageRef) |
| `content` | [`OutboundContent`](https://botmesh.afaya.com.co/api/core/type-aliases/OutboundContent) |

#### Returns

`Promise`\<[`SendResult`](https://botmesh.afaya.com.co/api/core/interfaces/SendResult)\<`unknown`>>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`editMessage`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#editmessage)

***

### acknowledgeInteraction()

```ts theme={null}
acknowledgeInteraction(interactionId, opts?): Promise<void>;
```

Defined in: [testing/MockProvider.ts:295](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L295)

Records the ack in [acks](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#acks) (button/callback interactions).

#### Parameters

| Parameter | Type |
| - | - |
| `interactionId` | `string` |
| `opts?` | \{ `text?`: `string`; `defer?`: `boolean`; } |
| `opts.text?` | `string` |
| `opts.defer?` | `boolean` |

#### Returns

`Promise`\<`void`>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`acknowledgeInteraction`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#acknowledgeinteraction)

***

### deleteMessage()

```ts theme={null}
deleteMessage(ref): Promise<void>;
```

Defined in: [testing/MockProvider.ts:300](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L300)

Records the ref in [deleted](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#deleted). Hidden (`undefined`) unless enabled — see [MockProviderOptions.supports](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockProviderOptions.md#supports).

#### Parameters

| Parameter | Type |
| - | - |
| `ref` | [`MessageRef`](https://botmesh.afaya.com.co/api/core/interfaces/MessageRef) |

#### Returns

`Promise`\<`void`>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`deleteMessage`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#deletemessage)

***

### sendDraft()

```ts theme={null}
sendDraft(
   chatId, 
   draftId, 
   text, 
   opts?
): Promise<void>;
```

Defined in: [testing/MockProvider.ts:305](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L305)

Records the draft in [drafts](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#drafts). Hidden (`undefined`) unless enabled — see [MockProviderOptions.supports](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockProviderOptions.md#supports).

#### Parameters

| Parameter | Type |
| - | - |
| `chatId` | `string` |
| `draftId` | `number` |
| `text` | `string` |
| `opts?` | [`DraftOptions`](https://botmesh.afaya.com.co/api/core/interfaces/DraftOptions) |

#### Returns

`Promise`\<`void`>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`sendDraft`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#senddraft)

***

### stopDraft()

```ts theme={null}
stopDraft(): boolean;
```

Defined in: [testing/MockProvider.ts:310](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L310)

Simulate the user pressing "stop" on the latest draft that offered it.

#### Returns

`boolean`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`stopDraft`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#stopdraft)

***

### start()

```ts theme={null}
start(): Promise<void>;
```

Defined in: [testing/MockProvider.ts:324](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L324)

#### Returns

`Promise`\<`void`>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`start`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#start)

***

### stop()

```ts theme={null}
stop(): Promise<void>;
```

Defined in: [testing/MockProvider.ts:328](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L328)

#### Returns

`Promise`\<`void`>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`stop`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#stop)

***

### onEvent()

```ts theme={null}
onEvent(listener): () => void;
```

Defined in: [testing/MockProvider.ts:337](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L337)

Subscribe to the normalized event stream. Returns an unsubscriber.

#### Parameters

| Parameter | Type |
| - | - |
| `listener` | (`e`) => `void` \| `Promise`\<`void`> |

#### Returns

() => `void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`onEvent`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#onevent)

***

### downloadMedia()

```ts theme={null}
downloadMedia(ref?): Promise<Buffer<ArrayBufferLike>>;
```

Defined in: [testing/MockProvider.ts:348](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L348)

Bytes of a simulated media: a copy of the bytes behind the ref (`incomingMedia`,
`chat.sendMedia`); an empty buffer for a legacy `token: null` ref
(`incoming(text, { type: 'image' })`). A `{ url }` token without bytes rejects with
`MediaUnavailableError` — the mock never touches the network.

#### Parameters

| Parameter | Type |
| - | - |
| `ref?` | [`MediaRef`](https://botmesh.afaya.com.co/api/core/interfaces/MediaRef) |

#### Returns

`Promise`\<`Buffer`\<`ArrayBufferLike`>>

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`downloadMedia`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#downloadmedia)

***

### clearJournal()

```ts theme={null}
clearJournal(): void;
```

Defined in: [testing/MockProvider.ts:361](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L361)

Forget the journal (the `seq` counter keeps growing; `outbox` is untouched).

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`clearJournal`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#clearjournal)

***

### incoming()

```ts theme={null}
incoming(text, opts?): void;
```

Defined in: [testing/MockProvider.ts:384](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L384)

Simulate an incoming message.

#### Parameters

| Parameter | Type |
| - | - |
| `text` | `string` |
| `opts?` | [`MockIncomingOptions`](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockIncomingOptions) |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`incoming`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#incoming)

***

### incomingMedia()

```ts theme={null}
incomingMedia(
   kind, 
   source, 
   opts?
): void;
```

Defined in: [testing/MockProvider.ts:413](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L413)

Simulate an inbound media message (`type: kind`, body = caption). `source` bytes are
what [downloadMedia](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider.md#downloadmedia) returns; `{ url }` alone is metadata only, and the download
then rejects with `MediaUnavailableError`.

#### Parameters

| Parameter | Type |
| - | - |
| `kind` | \| `"image"` \| `"video"` \| `"audio"` \| `"voice"` \| `"document"` \| `"sticker"` \| `"location"` \| `"contact"` |
| `source` | [`MockMediaSource`](https://botmesh.afaya.com.co/api/core/testing/type-aliases/MockMediaSource) |
| `opts?` | [`MockIncomingOptions`](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockIncomingOptions) & [`MockMediaOptions`](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockMediaOptions) |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`incomingMedia`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#incomingmedia)

***

### incomingLocation()

```ts theme={null}
incomingLocation(location, opts?): void;
```

Defined in: [testing/MockProvider.ts:436](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L436)

Simulate a shared location (`type: 'location'`, `ctx.sharedLocation`). The body is
the place name, else the address, else `''` — as the real providers set it.

#### Parameters

| Parameter | Type |
| - | - |
| `location` | [`InboundLocation`](https://botmesh.afaya.com.co/api/core/interfaces/InboundLocation) |
| `opts?` | `Omit`\<[`MockIncomingOptions`](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockIncomingOptions), `"location"` \| `"type"`> |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`incomingLocation`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#incominglocation)

***

### interaction()

```ts theme={null}
interaction(data, opts?): void;
```

Defined in: [testing/MockProvider.ts:441](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L441)

Simulate a UI interaction (button/list row/slash command; `kind` defaults to `'button'`).

#### Parameters

| Parameter | Type |
| - | - |
| `data` | `string` |
| `opts?` | [`MockIncomingOptions`](https://botmesh.afaya.com.co/api/core/testing/interfaces/MockIncomingOptions) |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`interaction`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#interaction)

***

### reaction()

```ts theme={null}
reaction(emoji, opts): void;
```

Defined in: [testing/MockProvider.ts:465](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L465)

Simulate a reaction to a message (`bot.on('reaction')`, `'reaction'` hooks). `to` is
the reacted message; the sender defaults to `from` (the chat), as in a DM.

#### Parameters

| Parameter | Type |
| - | - |
| `emoji` | `string` |
| `opts` | \{ `to`: [`MessageRef`](https://botmesh.afaya.com.co/api/core/interfaces/MessageRef); `from?`: `string`; `sender?`: `string`; `removed?`: `boolean`; } |
| `opts.to` | [`MessageRef`](https://botmesh.afaya.com.co/api/core/interfaces/MessageRef) |
| `opts.from?` | `string` |
| `opts.sender?` | `string` |
| `opts.removed?` | `boolean` |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`reaction`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#reaction)

***

### call()

```ts theme={null}
call(opts?): void;
```

Defined in: [testing/MockProvider.ts:478](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/MockProvider.ts#L478)

Simulate an inbound call notification (what `bot.on('call')` and the `CALL`
trigger receive). Reuse the same `id` to emit later updates of one call. For a
group call pass `chatId` (the group) and `isGroup: true`; `from` is the caller.

#### Parameters

| Parameter | Type |
| - | - |
| `opts?` | `Partial`\<[`CallEvent`](https://botmesh.afaya.com.co/api/core/interfaces/CallEvent)> |

#### Returns

`void`

#### Inherited from

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`call`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#call)

***

### crash()

```ts theme={null}
crash(): void;
```

Defined in: [testing/crash.ts:140](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/crash.ts#L140)

Stop delivering sends: every later `send` hangs forever.

#### Returns

`void`

***

### send()

```ts theme={null}
send(
   chatId, 
   content, 
   options?
): Promise<SendResult<unknown>>;
```

Defined in: [testing/crash.ts:142](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/crash.ts#L142)

Send normalized content. Rejects with a typed error (section 8) on failure.

#### Parameters

| Parameter | Type |
| - | - |
| `chatId` | `string` |
| `content` | [`OutboundContent`](https://botmesh.afaya.com.co/api/core/type-aliases/OutboundContent) |
| `options?` | [`SendOptions`](https://botmesh.afaya.com.co/api/core/interfaces/SendOptions) |

#### Returns

`Promise`\<[`SendResult`](https://botmesh.afaya.com.co/api/core/interfaces/SendResult)\<`unknown`>>

#### Overrides

[`MockProvider`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider).[`send`](https://botmesh.afaya.com.co/api/core/testing/classes/MockProvider#send)

## Accessors

### crashed

#### Get Signature

```ts theme={null}
get crashed(): boolean;
```

Defined in: [testing/crash.ts:141](https://github.com/andresayac/botmesh/blob/main/packages/core/src/testing/crash.ts#L141)

##### Returns

`boolean`


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.