# workerd

## Classes

### InvokeError

**`Internal`**

Transport-level `/invoke` failure (never an author failure): unknown
interface/method, malformed message, bad capability table, or a missing
binding.

#### Extends

- [`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror)

#### Constructors

##### Constructor

```ts
new InvokeError(
   status, 
   code, 
   message
): InvokeError;
```

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `status` | `number` |
| `code` | `string` |
| `message` | `string` |

###### Returns

[`InvokeError`](#invokeerror)

###### Overrides

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`constructor`](/docs/plugins/sdk/typescript/index.md#constructor-1)

#### Properties

##### code

```ts
readonly code: string;
```

Known `PluginErrorCode` wire string, or `unknown`.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`code`](/docs/plugins/sdk/typescript/index.md#code)

##### details

```ts
readonly details: Readonly<Record<string, unknown>> | undefined;
```

Structured detail object from the wire (`details` JSON), when the error carries one.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`details`](/docs/plugins/sdk/typescript/index.md#details)

##### status

```ts
readonly status: number;
```

HTTP status the bridge answers with.

##### wireCode

```ts
readonly wireCode: string;
```

Raw wire code, including codes this SDK does not know.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`wireCode`](/docs/plugins/sdk/typescript/index.md#wirecode)

#### Accessors

##### detailsText

###### Get Signature

```ts
get detailsText(): string;
```

`details` as the JSON text the wire carries.

###### Returns

`string`

JSON object text, or an empty string when the error has none.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`detailsText`](/docs/plugins/sdk/typescript/index.md#detailstext)

##### limit

###### Get Signature

```ts
get limit(): LimitExceeded | undefined;
```

The exceeded cap when this is a `limit_exceeded` error.

###### Returns

[`LimitExceeded`](/docs/plugins/sdk/typescript/index.md#limitexceeded-1) \| `undefined`

The cap from `details` first, then from the canonical message;
`undefined` for every other code.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`limit`](/docs/plugins/sdk/typescript/index.md#limit)

#### Methods

##### fromWire()

```ts
static fromWire(
   code, 
   message, 
   details?
): PluginError;
```

Construct a [PluginError](/docs/plugins/sdk/typescript/index.md#pluginerror) from a Cap'n Proto / JSON wire code.

Unknown codes become `unknown` on [PluginError.code](/docs/plugins/sdk/typescript/index.md#code) while
[PluginError.wireCode](/docs/plugins/sdk/typescript/index.md#wirecode) keeps the raw value.

###### Parameters

| Parameter | Type | Default value | Description |
| ------ | ------ | ------ | ------ |
| `code` | `string` | `undefined` | Wire error code (known or unknown). |
| `message` | `string` | `undefined` | Operator-facing error text. |
| `details?` | `string` | `""` | `details` JSON text from the wire (empty when none). |

###### Returns

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror)

Typed plugin error.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`fromWire`](/docs/plugins/sdk/typescript/index.md#fromwire)

##### limitExceeded()

```ts
static limitExceeded(limit): PluginError;
```

Builds a `limit_exceeded` error whose message and `details` both carry
the exceeded cap.

###### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `limit` | [`LimitExceeded`](/docs/plugins/sdk/typescript/index.md#limitexceeded-1) | Exceeded cap. |

###### Returns

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror)

Typed plugin error.

###### Inherited from

[`PluginError`](/docs/plugins/sdk/typescript/index.md#pluginerror).[`limitExceeded`](/docs/plugins/sdk/typescript/index.md#limitexceeded)

## Interfaces

### CapDescriptor

**`Internal`**

One `X-Bookclerk-Caps` entry: capability index `i` of the message is
described by entry `i`.

#### Properties

##### binding?

```ts
binding?: string;
```

Binding name for `guestDatabase`.

##### id?

```ts
id?: string;
```

Isolate object id for `adapterSession`.

##### kind

```ts
kind: string;
```

`source` / `destination` / `progress` / `cancellation` / … / `adapterSession`.

##### token?

```ts
token?: string;
```

Grant token for host-served kinds.

***

### InvokeFailure

**`Internal`**

Transport-level `/invoke` failure as a plain value (Workers RPC drops own
properties of thrown errors, so the adapter returns this instead of
throwing across the service binding).

#### Properties

##### error

```ts
error: object;
```

JSON error body.

###### code

```ts
code: string;
```

###### message

```ts
message: string;
```

##### status

```ts
status: number;
```

HTTP status the bridge answers with (`400` / `404` / `500`).

***

### InvokeHost

**`Internal`**

Adapter hooks the dispatcher calls back into.

#### Methods

##### author()

```ts
author(): AuthorStub | undefined;
```

Default author entrypoint (`PLUGIN`), or `undefined` when unbound.

###### Returns

[`AuthorStub`](/docs/plugins/sdk/typescript/plugin/index.md#authorstub) \| `undefined`

##### bindContext()

```ts
bindContext(ctx): GrantedContext;
```

Bridge context → author-facing granted context.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `ctx` | [`BridgeContext`](/docs/plugins/sdk/typescript/plugin/index.md#bridgecontext) \| `undefined` |

###### Returns

[`GrantedContext`](/docs/plugins/sdk/typescript/plugin/index.md#grantedcontext)

##### importCap()

```ts
importCap(descriptor, stop): unknown;
```

Resolve one request capability descriptor; `undefined` for an unknown
kind. `stop` aborts when the call returns.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `descriptor` | [`CapDescriptor`](#capdescriptor) |
| `stop` | `AbortSignal` |

###### Returns

`unknown`

##### named()

```ts
named(name): NamedStub | undefined;
```

Named author entrypoint, or `undefined` when the isolate does not export it.

###### Parameters

| Parameter | Type |
| ------ | ------ |
| `name` | [`EntrypointName`](/docs/plugins/sdk/typescript/plugin/index.md#entrypointname) |

###### Returns

[`NamedStub`](/docs/plugins/sdk/typescript/plugin/index.md#namedstub) \| `undefined`

***

### InvokeReply

**`Internal`**

Successful `/invoke` reply: `$Results` bytes plus the descriptors of
capabilities the reply exported.

#### Properties

##### body

```ts
body: Uint8Array;
```

Unpacked single-segment Cap'n message (`<Interface>.<method>$Results`).

##### caps

```ts
caps: CapDescriptor[];
```

Reply capability table (`X-Bookclerk-Caps` on the response).

## Type Aliases

### InvokeOutcome

```ts
type InvokeOutcome = InvokeReply | InvokeFailure;
```

**`Internal`**

What the adapter's `invoke` resolves to.

## Functions

### dispatchInvoke()

```ts
function dispatchInvoke(
   iface, 
   method, 
   context, 
   caps, 
   target, 
   body, 
   host
): Promise<InvokeReply>;
```

**`Internal`**

Dispatch one `/invoke` call.

#### Parameters

| Parameter | Type | Description |
| ------ | ------ | ------ |
| `iface` | `string` | Cap'n interface name (`X-Bookclerk-Interface`). |
| `method` | `string` | Method name (`X-Bookclerk-Method`). |
| `context` | [`BridgeContext`](/docs/plugins/sdk/typescript/plugin/index.md#bridgecontext) \| `undefined` | Decoded bridge context, or `undefined` for `PluginWorker.*`. |
| `caps` | [`CapDescriptor`](#capdescriptor)[] | Request capability descriptors (`X-Bookclerk-Caps`). |
| `target` | `string` \| `null` | Isolate object id (`X-Bookclerk-Target`), or `null`. |
| `body` | `Uint8Array` | `$Params` message bytes. |
| `host` | [`InvokeHost`](#invokehost) | Adapter hooks. |

#### Returns

`Promise`\<[`InvokeReply`](#invokereply)\>

`$Results` bytes plus reply capability descriptors.

#### Throws

On transport-level failures (`400` / `404` / `500`).

## References

### Abridgement

Re-exports [Abridgement](/docs/plugins/sdk/typescript/abi/index.md#abridgement)

***

### AdapterBatchOptions

Re-exports [AdapterBatchOptions](/docs/plugins/sdk/typescript/index.md#adapterbatchoptions)

***

### AdapterBatchRequest

Re-exports [AdapterBatchRequest](/docs/plugins/sdk/typescript/index.md#adapterbatchrequest)

***

### AdapterBatchStatement

Re-exports [AdapterBatchStatement](/docs/plugins/sdk/typescript/index.md#adapterbatchstatement)

***

### AdapterBatchStreamedOptions

Re-exports [AdapterBatchStreamedOptions](/docs/plugins/sdk/typescript/index.md#adapterbatchstreamedoptions)

***

### AdapterDatabaseSession

Re-exports [AdapterDatabaseSession](/docs/plugins/sdk/typescript/plugin/index.md#adapterdatabasesession)

***

### AdapterEnv

Re-exports [AdapterEnv](/docs/plugins/sdk/typescript/plugin/index.md#adapterenv)

***

### AdapterTransaction

Re-exports [AdapterTransaction](/docs/plugins/sdk/typescript/index.md#adaptertransaction)

***

### AiBinding

Re-exports [AiBinding](/docs/plugins/sdk/typescript/env/index.md#aibinding)

***

### AiEmbedText

Re-exports [AiEmbedText](/docs/plugins/sdk/typescript/generated/index.md#aiembedtext)

***

### AiEntrypoint

Re-exports [AiEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#aientrypoint)

***

### AiInput

Re-exports [AiInput](/docs/plugins/sdk/typescript/generated/index.md#aiinput)

***

### AiModel

Re-exports [AiModel](/docs/plugins/sdk/typescript/generated/index.md#aimodel)

***

### AiModelList

Re-exports [AiModelList](/docs/plugins/sdk/typescript/generated/index.md#aimodellist)

***

### AiOutput

Re-exports [AiOutput](/docs/plugins/sdk/typescript/generated/index.md#aioutput)

***

### AiRunOk

Re-exports [AiRunOk](/docs/plugins/sdk/typescript/generated/index.md#airunok)

***

### AiRunParams

Re-exports [AiRunParams](/docs/plugins/sdk/typescript/generated/index.md#airunparams)

***

### AiTask

Re-exports [AiTask](/docs/plugins/sdk/typescript/abi/index.md#aitask)

***

### AiTextEmbeddingsInput

Re-exports [AiTextEmbeddingsInput](/docs/plugins/sdk/typescript/generated/index.md#aitextembeddingsinput)

***

### AiTextEmbeddingsOutput

Re-exports [AiTextEmbeddingsOutput](/docs/plugins/sdk/typescript/generated/index.md#aitextembeddingsoutput)

***

### AiTextEmbeddingsRequest

Re-exports [AiTextEmbeddingsRequest](/docs/plugins/sdk/typescript/env/index.md#aitextembeddingsrequest)

***

### AiTextEmbeddingsResponse

Re-exports [AiTextEmbeddingsResponse](/docs/plugins/sdk/typescript/env/index.md#aitextembeddingsresponse)

***

### AiTextRole

Re-exports [AiTextRole](/docs/plugins/sdk/typescript/abi/index.md#aitextrole)

***

### allowedEntrypointFamilies

Re-exports [allowedEntrypointFamilies](/docs/plugins/sdk/typescript/plugin/index.md#allowedentrypointfamilies)

***

### AtomicTransport

Re-exports [AtomicTransport](/docs/plugins/sdk/typescript/db-execute/index.md#atomictransport)

***

### AuthenticateUserParams

Re-exports [AuthenticateUserParams](/docs/plugins/sdk/typescript/generated/index.md#authenticateuserparams)

***

### BookclerkEntrypoint

Re-exports [BookclerkEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#bookclerkentrypoint)

***

### BookclerkEnv

Re-exports [BookclerkEnv](/docs/plugins/sdk/typescript/env/index.md#bookclerkenv)

***

### canonicalExecuteRequestHash

Re-exports [canonicalExecuteRequestHash](/docs/plugins/sdk/typescript/db-execute/index.md#canonicalexecuterequesthash)

***

### ChangesPage

Re-exports [ChangesPage](/docs/plugins/sdk/typescript/plugin/index.md#changespage)

***

### ChangesRequest

Re-exports [ChangesRequest](/docs/plugins/sdk/typescript/plugin/index.md#changesrequest)

***

### Checkpoint

Re-exports [Checkpoint](/docs/plugins/sdk/typescript/plugin/index.md#checkpoint-4)

***

### chunkIndexes

Re-exports [chunkIndexes](/docs/plugins/sdk/typescript/db-execute/index.md#chunkindexes)

***

### cliArgs

Re-exports [cliArgs](/docs/plugins/sdk/typescript/plugin/index.md#cliargs)

***

### CliEntrypoint

Re-exports [CliEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#clientrypoint)

***

### CliInvokeParams

Re-exports [CliInvokeParams](/docs/plugins/sdk/typescript/generated/index.md#cliinvokeparams)

***

### CliInvokeResult

Re-exports [CliInvokeResult](/docs/plugins/sdk/typescript/generated/index.md#cliinvokeresult)

***

### CliSchema

Re-exports [CliSchema](/docs/plugins/sdk/typescript/generated/index.md#clischema)

***

### collectExecuteStream

Re-exports [collectExecuteStream](/docs/plugins/sdk/typescript/index.md#collectexecutestream)

***

### CopyResult

Re-exports [CopyResult](/docs/plugins/sdk/typescript/plugin/index.md#copyresult)

***

### CoverEntrypoint

Re-exports [CoverEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#coverentrypoint)

***

### CoverFetchParams

Re-exports [CoverFetchParams](/docs/plugins/sdk/typescript/generated/index.md#coverfetchparams)

***

### CoverImage

Re-exports [CoverImage](/docs/plugins/sdk/typescript/generated/index.md#coverimage)

***

### CoverImages

Re-exports [CoverImages](/docs/plugins/sdk/typescript/generated/index.md#coverimages)

***

### createDatabaseBinding

Re-exports [createDatabaseBinding](/docs/plugins/sdk/typescript/db-execute/index.md#createdatabasebinding)

***

### Credit

Re-exports [Credit](/docs/plugins/sdk/typescript/generated/index.md#credit)

***

### CreditLevel

Re-exports [CreditLevel](/docs/plugins/sdk/typescript/abi/index.md#creditlevel)

***

### CreditRole

Re-exports [CreditRole](/docs/plugins/sdk/typescript/abi/index.md#creditrole)

***

### D1ExecResult

Re-exports [D1ExecResult](/docs/plugins/sdk/typescript/db-execute/index.md#d1execresult)

***

### D1Meta

Re-exports [D1Meta](/docs/plugins/sdk/typescript/db-execute/index.md#d1meta)

***

### D1Result

Re-exports [D1Result](/docs/plugins/sdk/typescript/db-execute/index.md#d1result)

***

### DatabaseAdapterEntrypoint

Re-exports [DatabaseAdapterEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#databaseadapterentrypoint)

***

### DatabaseBinding

Re-exports [DatabaseBinding](/docs/plugins/sdk/typescript/db-execute/index.md#databasebinding)

***

### DatabaseBindingOptions

Re-exports [DatabaseBindingOptions](/docs/plugins/sdk/typescript/db-execute/index.md#databasebindingoptions)

***

### dataMigrationOp

Re-exports [dataMigrationOp](/docs/plugins/sdk/typescript/plugin/index.md#datamigrationop)

***

### DbColumn

Re-exports [DbColumn](/docs/plugins/sdk/typescript/db-execute/index.md#dbcolumn)

***

### DbResultSelection

Re-exports [DbResultSelection](/docs/plugins/sdk/typescript/abi/index.md#dbresultselection)

***

### DbRow

Re-exports [DbRow](/docs/plugins/sdk/typescript/db-execute/index.md#dbrow)

***

### DbStatementKind

Re-exports [DbStatementKind](/docs/plugins/sdk/typescript/abi/index.md#dbstatementkind)

***

### DbTiming

Re-exports [DbTiming](/docs/plugins/sdk/typescript/db-execute/index.md#dbtiming)

***

### DbType

Re-exports [DbType](/docs/plugins/sdk/typescript/abi/index.md#dbtype)

***

### DbValue

Re-exports [DbValue](/docs/plugins/sdk/typescript/db-value/index.md#dbvalue)

***

### decodeDbValue

Re-exports [decodeDbValue](/docs/plugins/sdk/typescript/db-value/index.md#decodedbvalue)

***

### decodeExecuteRequest

Re-exports [decodeExecuteRequest](/docs/plugins/sdk/typescript/db-execute/index.md#decodeexecuterequest)

***

### decodeExecuteResultReply

Re-exports [decodeExecuteResultReply](/docs/plugins/sdk/typescript/db-execute/index.md#decodeexecuteresultreply)

***

### decodeExecuteStream

Re-exports [decodeExecuteStream](/docs/plugins/sdk/typescript/index.md#decodeexecutestream)

***

### decodeExtensibleConfig

Re-exports [decodeExtensibleConfig](/docs/plugins/sdk/typescript/plugin/index.md#decodeextensibleconfig)

***

### DeliveredCheckpoint

Re-exports [DeliveredCheckpoint](/docs/plugins/sdk/typescript/plugin/index.md#deliveredcheckpoint)

***

### Destination

Re-exports [Destination](/docs/plugins/sdk/typescript/plugin/index.md#destination)

***

### DomainEvent

Re-exports [DomainEvent](/docs/plugins/sdk/typescript/generated/index.md#domainevent)

***

### encodeDbValue

Re-exports [encodeDbValue](/docs/plugins/sdk/typescript/db-value/index.md#encodedbvalue)

***

### encodeExecuteRequest

Re-exports [encodeExecuteRequest](/docs/plugins/sdk/typescript/db-execute/index.md#encodeexecuterequest)

***

### encodeExecuteResultReply

Re-exports [encodeExecuteResultReply](/docs/plugins/sdk/typescript/db-execute/index.md#encodeexecuteresultreply)

***

### encodeExecuteStream

Re-exports [encodeExecuteStream](/docs/plugins/sdk/typescript/index.md#encodeexecutestream)

***

### ENTRYPOINT\_BINDINGS

Re-exports [ENTRYPOINT_BINDINGS](/docs/plugins/sdk/typescript/plugin/index.md#entrypoint_bindings)

***

### ENTRYPOINT\_CLASSES

Re-exports [ENTRYPOINT_CLASSES](/docs/plugins/sdk/typescript/plugin/index.md#entrypoint_classes)

***

### EntrypointName

Re-exports [EntrypointName](/docs/plugins/sdk/typescript/plugin/index.md#entrypointname)

***

### EventBatch

Re-exports [EventBatch](/docs/plugins/sdk/typescript/plugin/index.md#eventbatch)

***

### eventBatchResults

Re-exports [eventBatchResults](/docs/plugins/sdk/typescript/plugin/index.md#eventbatchresults)

***

### EventMessage

Re-exports [EventMessage](/docs/plugins/sdk/typescript/plugin/index.md#eventmessage)

***

### EventOutcome

Re-exports [EventOutcome](/docs/plugins/sdk/typescript/plugin/index.md#eventoutcome)

***

### EventPublisherBinding

Re-exports [EventPublisherBinding](/docs/plugins/sdk/typescript/env/index.md#eventpublisherbinding)

***

### EventReadOptions

Re-exports [EventReadOptions](/docs/plugins/sdk/typescript/env/index.md#eventreadoptions)

***

### EventSuspendOptions

Re-exports [EventSuspendOptions](/docs/plugins/sdk/typescript/plugin/index.md#eventsuspendoptions)

***

### executeAdapterBatch

Re-exports [executeAdapterBatch](/docs/plugins/sdk/typescript/index.md#executeadapterbatch)

***

### executeAdapterBatchStreamed

Re-exports [executeAdapterBatchStreamed](/docs/plugins/sdk/typescript/index.md#executeadapterbatchstreamed)

***

### ExecuteReply

Re-exports [ExecuteReply](/docs/plugins/sdk/typescript/db-execute/index.md#executereply)

***

### executeReplyToD1Results

Re-exports [executeReplyToD1Results](/docs/plugins/sdk/typescript/db-execute/index.md#executereplytod1results)

***

### ExecuteRequest

Re-exports [ExecuteRequest](/docs/plugins/sdk/typescript/db-execute/index.md#executerequest)

***

### ExecuteStreamDecoder

Re-exports [ExecuteStreamDecoder](/docs/plugins/sdk/typescript/index.md#executestreamdecoder)

***

### executeStreamLimits

Re-exports [executeStreamLimits](/docs/plugins/sdk/typescript/index.md#executestreamlimits-1)

***

### ExecuteStreamLimits

Re-exports [ExecuteStreamLimits](/docs/plugins/sdk/typescript/index.md#executestreamlimits)

***

### ExpressionKind

Re-exports [ExpressionKind](/docs/plugins/sdk/typescript/abi/index.md#expressionkind)

***

### ExtensibleConfig

Re-exports [ExtensibleConfig](/docs/plugins/sdk/typescript/generated/index.md#extensibleconfig)

***

### ExternalUser

Re-exports [ExternalUser](/docs/plugins/sdk/typescript/generated/index.md#externaluser)

***

### FEATURE\_SCALAR\_LIMITS

Re-exports [FEATURE_SCALAR_LIMITS](/docs/plugins/sdk/typescript/abi/index.md#feature_scalar_limits)

***

### FEATURE\_STORAGE\_CHANGES

Re-exports [FEATURE_STORAGE_CHANGES](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_changes)

***

### FEATURE\_STORAGE\_CONDITIONAL\_WRITE

Re-exports [FEATURE_STORAGE_CONDITIONAL_WRITE](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_conditional_write)

***

### FEATURE\_STORAGE\_COPY

Re-exports [FEATURE_STORAGE_COPY](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_copy)

***

### FEATURE\_STORAGE\_DELETE\_MANY

Re-exports [FEATURE_STORAGE_DELETE_MANY](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_delete_many)

***

### FEATURE\_STORAGE\_HEAD\_MANY

Re-exports [FEATURE_STORAGE_HEAD_MANY](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_head_many)

***

### FEATURE\_STORAGE\_MOVE

Re-exports [FEATURE_STORAGE_MOVE](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_move)

***

### FEATURE\_STORAGE\_MOVE\_MANY

Re-exports [FEATURE_STORAGE_MOVE_MANY](/docs/plugins/sdk/typescript/abi/index.md#feature_storage_move_many)

***

### FEATURE\_STREAMS

Re-exports [FEATURE_STREAMS](/docs/plugins/sdk/typescript/abi/index.md#feature_streams)

***

### FetchStorePage

Re-exports [FetchStorePage](/docs/plugins/sdk/typescript/index.md#fetchstorepage)

***

### fromBridgeJson

Re-exports [fromBridgeJson](/docs/plugins/sdk/typescript/plugin/index.md#frombridgejson)

***

### GrantedContext

Re-exports [GrantedContext](/docs/plugins/sdk/typescript/plugin/index.md#grantedcontext)

***

### GrantedDatabaseTransport

Re-exports [GrantedDatabaseTransport](/docs/plugins/sdk/typescript/plugin/index.md#granteddatabasetransport)

***

### GUEST\_READ\_ONLY\_REPLAY\_PAYLOAD

Re-exports [GUEST_READ_ONLY_REPLAY_PAYLOAD](/docs/plugins/sdk/typescript/index.md#guest_read_only_replay_payload)

***

### GUEST\_RECEIPT\_CLAIM\_LOST

Re-exports [GUEST_RECEIPT_CLAIM_LOST](/docs/plugins/sdk/typescript/index.md#guest_receipt_claim_lost)

***

### GUEST\_RECEIPT\_RESULT\_LOST

Re-exports [GUEST_RECEIPT_RESULT_LOST](/docs/plugins/sdk/typescript/index.md#guest_receipt_result_lost)

***

### GUEST\_RECEIPT\_STUB\_SUFFIX

Re-exports [GUEST_RECEIPT_STUB_SUFFIX](/docs/plugins/sdk/typescript/index.md#guest_receipt_stub_suffix)

***

### GUEST\_RECEIPT\_WRAP\_PREFIX

Re-exports [GUEST_RECEIPT_WRAP_PREFIX](/docs/plugins/sdk/typescript/index.md#guest_receipt_wrap_prefix)

***

### GUEST\_REPLAY\_PAYLOAD\_MAX\_BYTES

Re-exports [GUEST_REPLAY_PAYLOAD_MAX_BYTES](/docs/plugins/sdk/typescript/index.md#guest_replay_payload_max_bytes)

***

### guestBatchIsReadOnly

Re-exports [guestBatchIsReadOnly](/docs/plugins/sdk/typescript/index.md#guestbatchisreadonly)

***

### guestReceiptFinalizeStatements

Re-exports [guestReceiptFinalizeStatements](/docs/plugins/sdk/typescript/index.md#guestreceiptfinalizestatements)

***

### guestReplayPayload

Re-exports [guestReplayPayload](/docs/plugins/sdk/typescript/index.md#guestreplaypayload)

***

### HealthOk

Re-exports [HealthOk](/docs/plugins/sdk/typescript/generated/index.md#healthok)

***

### HostWebSocket

Re-exports [HostWebSocket](/docs/plugins/sdk/typescript/env/index.md#hostwebsocket)

***

### Identifier

Re-exports [Identifier](/docs/plugins/sdk/typescript/generated/index.md#identifier)

***

### IdentifierScheme

Re-exports [IdentifierScheme](/docs/plugins/sdk/typescript/abi/index.md#identifierscheme)

***

### IngressEntrypoint

Re-exports [IngressEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#ingressentrypoint)

***

### Instant

Re-exports [Instant](/docs/plugins/sdk/typescript/plugin/index.md#instant)

***

### Invocation

Re-exports [Invocation](/docs/plugins/sdk/typescript/generated/index.md#invocation)

***

### invocationOf

Re-exports [invocationOf](/docs/plugins/sdk/typescript/plugin/index.md#invocationof)

***

### JobCheckpoint

Re-exports [JobCheckpoint](/docs/plugins/sdk/typescript/plugin/index.md#jobcheckpoint)

***

### JobCompletion

Re-exports [JobCompletion](/docs/plugins/sdk/typescript/plugin/index.md#jobcompletion)

***

### JobController

Re-exports [JobController](/docs/plugins/sdk/typescript/plugin/index.md#jobcontroller)

***

### JobInvocation

Re-exports [JobInvocation](/docs/plugins/sdk/typescript/generated/index.md#jobinvocation)

***

### jobOutcomeFor

Re-exports [jobOutcomeFor](/docs/plugins/sdk/typescript/plugin/index.md#joboutcomefor)

***

### JobOutcomeRecord

Re-exports [JobOutcomeRecord](/docs/plugins/sdk/typescript/plugin/index.md#joboutcomerecord)

***

### JobRetryOptions

Re-exports [JobRetryOptions](/docs/plugins/sdk/typescript/plugin/index.md#jobretryoptions)

***

### JobRunnerContext

Re-exports [JobRunnerContext](/docs/plugins/sdk/typescript/plugin/index.md#jobrunnercontext)

***

### JobSuspendOptions

Re-exports [JobSuspendOptions](/docs/plugins/sdk/typescript/plugin/index.md#jobsuspendoptions)

***

### JsonObject

Re-exports [JsonObject](/docs/plugins/sdk/typescript/env/index.md#jsonobject)

***

### jsonPayload

Re-exports [jsonPayload](/docs/plugins/sdk/typescript/plugin/index.md#jsonpayload)

***

### KeyOutcome

Re-exports [KeyOutcome](/docs/plugins/sdk/typescript/plugin/index.md#keyoutcome)

***

### KvListKeyBinding

Re-exports [KvListKeyBinding](/docs/plugins/sdk/typescript/env/index.md#kvlistkeybinding)

***

### KvListOptionsBinding

Re-exports [KvListOptionsBinding](/docs/plugins/sdk/typescript/env/index.md#kvlistoptionsbinding)

***

### KvListResultBinding

Re-exports [KvListResultBinding](/docs/plugins/sdk/typescript/env/index.md#kvlistresultbinding)

***

### KvNamespaceBinding

Re-exports [KvNamespaceBinding](/docs/plugins/sdk/typescript/env/index.md#kvnamespacebinding)

***

### KvPutOptionsBinding

Re-exports [KvPutOptionsBinding](/docs/plugins/sdk/typescript/env/index.md#kvputoptionsbinding)

***

### KvValueType

Re-exports [KvValueType](/docs/plugins/sdk/typescript/env/index.md#kvvaluetype)

***

### KvValueWithMetadata

Re-exports [KvValueWithMetadata](/docs/plugins/sdk/typescript/env/index.md#kvvaluewithmetadata)

***

### ListeningProgress

Re-exports [ListeningProgress](/docs/plugins/sdk/typescript/generated/index.md#listeningprogress)

***

### ListOptions

Re-exports [ListOptions](/docs/plugins/sdk/typescript/plugin/index.md#listoptions)

***

### ListPage

Re-exports [ListPage](/docs/plugins/sdk/typescript/plugin/index.md#listpage)

***

### MAX\_BATCH\_KEYS

Re-exports [MAX_BATCH_KEYS](/docs/plugins/sdk/typescript/abi/index.md#max_batch_keys)

***

### MAX\_CHANGES\_CURSOR\_BYTES

Re-exports [MAX_CHANGES_CURSOR_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_changes_cursor_bytes)

***

### MAX\_CHANGES\_PAGE

Re-exports [MAX_CHANGES_PAGE](/docs/plugins/sdk/typescript/abi/index.md#max_changes_page)

***

### MAX\_CHECKPOINT\_BYTES

Re-exports [MAX_CHECKPOINT_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_checkpoint_bytes)

***

### MAX\_EVENT\_PAYLOAD\_BYTES

Re-exports [MAX_EVENT_PAYLOAD_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_event_payload_bytes)

***

### MAX\_LIST\_PAGE

Re-exports [MAX_LIST_PAGE](/docs/plugins/sdk/typescript/abi/index.md#max_list_page)

***

### MAX\_PLUGIN\_MIGRATION\_OPS

Re-exports [MAX_PLUGIN_MIGRATION_OPS](/docs/plugins/sdk/typescript/abi/index.md#max_plugin_migration_ops)

***

### MAX\_PLUGIN\_MIGRATION\_REGISTRATION\_BYTES

Re-exports [MAX_PLUGIN_MIGRATION_REGISTRATION_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_plugin_migration_registration_bytes)

***

### MAX\_PLUGIN\_MIGRATION\_TOTAL\_OPS

Re-exports [MAX_PLUGIN_MIGRATION_TOTAL_OPS](/docs/plugins/sdk/typescript/abi/index.md#max_plugin_migration_total_ops)

***

### MAX\_SCALAR\_BYTES

Re-exports [MAX_SCALAR_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_scalar_bytes)

***

### MAX\_STREAM\_WINDOW\_BYTES

Re-exports [MAX_STREAM_WINDOW_BYTES](/docs/plugins/sdk/typescript/abi/index.md#max_stream_window_bytes)

***

### MAX\_WRITE\_KEY\_BYTES

Re-exports [MAX_WRITE_KEY_BYTES](/docs/plugins/sdk/typescript/db-execute/index.md#max_write_key_bytes)

***

### MediaKind

Re-exports [MediaKind](/docs/plugins/sdk/typescript/abi/index.md#mediakind)

***

### MetadataAudioFile

Re-exports [MetadataAudioFile](/docs/plugins/sdk/typescript/generated/index.md#metadataaudiofile)

***

### MetadataChapter

Re-exports [MetadataChapter](/docs/plugins/sdk/typescript/generated/index.md#metadatachapter)

***

### MetadataChapters

Re-exports [MetadataChapters](/docs/plugins/sdk/typescript/generated/index.md#metadatachapters)

***

### MetadataChaptersParams

Re-exports [MetadataChaptersParams](/docs/plugins/sdk/typescript/generated/index.md#metadatachaptersparams)

***

### MetadataEntrypoint

Re-exports [MetadataEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#metadataentrypoint)

***

### MetadataField

Re-exports [MetadataField](/docs/plugins/sdk/typescript/abi/index.md#metadatafield)

***

### MetadataFileParseParams

Re-exports [MetadataFileParseParams](/docs/plugins/sdk/typescript/generated/index.md#metadatafileparseparams)

***

### MetadataFileRecord

Re-exports [MetadataFileRecord](/docs/plugins/sdk/typescript/generated/index.md#metadatafilerecord)

***

### MetadataFileRenderParams

Re-exports [MetadataFileRenderParams](/docs/plugins/sdk/typescript/generated/index.md#metadatafilerenderparams)

***

### MetadataFilesEntrypoint

Re-exports [MetadataFilesEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#metadatafilesentrypoint)

***

### MetadataLookupParams

Re-exports [MetadataLookupParams](/docs/plugins/sdk/typescript/generated/index.md#metadatalookupparams)

***

### MetadataRecord

Re-exports [MetadataRecord](/docs/plugins/sdk/typescript/generated/index.md#metadatarecord)

***

### MetadataSearchParams

Re-exports [MetadataSearchParams](/docs/plugins/sdk/typescript/generated/index.md#metadatasearchparams)

***

### MoveManyPage

Re-exports [MoveManyPage](/docs/plugins/sdk/typescript/plugin/index.md#movemanypage)

***

### MoveManyRequest

Re-exports [MoveManyRequest](/docs/plugins/sdk/typescript/plugin/index.md#movemanyrequest)

***

### MoveOptions

Re-exports [MoveOptions](/docs/plugins/sdk/typescript/plugin/index.md#moveoptions)

***

### MoveResult

Re-exports [MoveResult](/docs/plugins/sdk/typescript/plugin/index.md#moveresult)

***

### NamedDatabase

Re-exports [NamedDatabase](/docs/plugins/sdk/typescript/plugin/index.md#nameddatabase)

***

### NamedEntrypoint

Re-exports [NamedEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#namedentrypoint)

***

### NamedKv

Re-exports [NamedKv](/docs/plugins/sdk/typescript/plugin/index.md#namedkv)

***

### NamedQueue

Re-exports [NamedQueue](/docs/plugins/sdk/typescript/plugin/index.md#namedqueue)

***

### NamedSockets

Re-exports [NamedSockets](/docs/plugins/sdk/typescript/plugin/index.md#namedsockets)

***

### NotificationAlertAction

Re-exports [NotificationAlertAction](/docs/plugins/sdk/typescript/abi/index.md#notificationalertaction)

***

### NotificationAudience

Re-exports [NotificationAudience](/docs/plugins/sdk/typescript/abi/index.md#notificationaudience)

***

### NotificationField

Re-exports [NotificationField](/docs/plugins/sdk/typescript/generated/index.md#notificationfield)

***

### NotificationMessage

Re-exports [NotificationMessage](/docs/plugins/sdk/typescript/generated/index.md#notificationmessage)

***

### NotificationSeverity

Re-exports [NotificationSeverity](/docs/plugins/sdk/typescript/abi/index.md#notificationseverity)

***

### NotifierEntrypoint

Re-exports [NotifierEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#notifierentrypoint)

***

### NotifyBinding

Re-exports [NotifyBinding](/docs/plugins/sdk/typescript/env/index.md#notifybinding)

***

### NotifyDestination

Re-exports [NotifyDestination](/docs/plugins/sdk/typescript/generated/index.md#notifydestination)

***

### NotifyDestinationKind

Re-exports [NotifyDestinationKind](/docs/plugins/sdk/typescript/abi/index.md#notifydestinationkind)

***

### NotifyRaise

Re-exports [NotifyRaise](/docs/plugins/sdk/typescript/env/index.md#notifyraise)

***

### NotifyRaised

Re-exports [NotifyRaised](/docs/plugins/sdk/typescript/generated/index.md#notifyraised)

***

### NotifySendParams

Re-exports [NotifySendParams](/docs/plugins/sdk/typescript/generated/index.md#notifysendparams)

***

### NotifySent

Re-exports [NotifySent](/docs/plugins/sdk/typescript/generated/index.md#notifysent)

***

### NotifyValidated

Re-exports [NotifyValidated](/docs/plugins/sdk/typescript/generated/index.md#notifyvalidated)

***

### NotifyValidateParams

Re-exports [NotifyValidateParams](/docs/plugins/sdk/typescript/generated/index.md#notifyvalidateparams)

***

### ObjectChange

Re-exports [ObjectChange](/docs/plugins/sdk/typescript/plugin/index.md#objectchange)

***

### ObjectInfo

Re-exports [ObjectInfo](/docs/plugins/sdk/typescript/plugin/index.md#objectinfo)

***

### ObjectMetadata

Re-exports [ObjectMetadata](/docs/plugins/sdk/typescript/plugin/index.md#objectmetadata)

***

### OidcClientTemplate

Re-exports [OidcClientTemplate](/docs/plugins/sdk/typescript/generated/index.md#oidcclienttemplate)

***

### OidcEntrypoint

Re-exports [OidcEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#oidcentrypoint)

***

### OriginBinding

Re-exports [OriginBinding](/docs/plugins/sdk/typescript/index.md#originbinding)

***

### OriginFetchOptions

Re-exports [OriginFetchOptions](/docs/plugins/sdk/typescript/index.md#originfetchoptions)

***

### OriginTransport

Re-exports [OriginTransport](/docs/plugins/sdk/typescript/index.md#origintransport)

***

### OriginTransportReply

Re-exports [OriginTransportReply](/docs/plugins/sdk/typescript/index.md#origintransportreply)

***

### OriginTransportResponse

Re-exports [OriginTransportResponse](/docs/plugins/sdk/typescript/index.md#origintransportresponse)

***

### packEmbeddingVectors

Re-exports [packEmbeddingVectors](/docs/plugins/sdk/typescript/plugin/index.md#packembeddingvectors)

***

### parseDbValue

Re-exports [parseDbValue](/docs/plugins/sdk/typescript/db-value/index.md#parsedbvalue)

***

### PluginCapabilities

Re-exports [PluginCapabilities](/docs/plugins/sdk/typescript/generated/index.md#plugincapabilities)

***

### PluginDescribe

Re-exports [PluginDescribe](/docs/plugins/sdk/typescript/plugin/index.md#plugindescribe)

***

### PluginError

Re-exports [PluginError](/docs/plugins/sdk/typescript/index.md#pluginerror)

***

### PluginMigration

Re-exports [PluginMigration](/docs/plugins/sdk/typescript/generated/index.md#pluginmigration)

***

### PluginMigrationOp

Re-exports [PluginMigrationOp](/docs/plugins/sdk/typescript/generated/index.md#pluginmigrationop)

***

### PreparedStatement

Re-exports [PreparedStatement](/docs/plugins/sdk/typescript/db-execute/index.md#preparedstatement)

***

### PRODUCT\_API\_VERSION

Re-exports [PRODUCT_API_VERSION](/docs/plugins/sdk/typescript/abi/index.md#product_api_version)

***

### ProgressSink

Re-exports [ProgressSink](/docs/plugins/sdk/typescript/plugin/index.md#progresssink)

***

### PublishEvent

Re-exports [PublishEvent](/docs/plugins/sdk/typescript/env/index.md#publishevent)

***

### PutResult

Re-exports [PutResult](/docs/plugins/sdk/typescript/plugin/index.md#putresult)

***

### QueueBatch

Re-exports [QueueBatch](/docs/plugins/sdk/typescript/plugin/index.md#queuebatch)

***

### queueBatchResults

Re-exports [queueBatchResults](/docs/plugins/sdk/typescript/plugin/index.md#queuebatchresults)

***

### QueueBinding

Re-exports [QueueBinding](/docs/plugins/sdk/typescript/env/index.md#queuebinding)

***

### QueueMessage

Re-exports [QueueMessage](/docs/plugins/sdk/typescript/plugin/index.md#queuemessage)

***

### QueueOutcome

Re-exports [QueueOutcome](/docs/plugins/sdk/typescript/plugin/index.md#queueoutcome)

***

### QueueRetryOptions

Re-exports [QueueRetryOptions](/docs/plugins/sdk/typescript/plugin/index.md#queueretryoptions)

***

### QueueSendBatchEntry

Re-exports [QueueSendBatchEntry](/docs/plugins/sdk/typescript/env/index.md#queuesendbatchentry)

***

### QueueSendOptions

Re-exports [QueueSendOptions](/docs/plugins/sdk/typescript/env/index.md#queuesendoptions)

***

### rawStreamCeiling

Re-exports [rawStreamCeiling](/docs/plugins/sdk/typescript/index.md#rawstreamceiling)

***

### ReadOptions

Re-exports [ReadOptions](/docs/plugins/sdk/typescript/plugin/index.md#readoptions)

***

### ReadResult

Re-exports [ReadResult](/docs/plugins/sdk/typescript/plugin/index.md#readresult)

***

### RemoteLibraryEntrypoint

Re-exports [RemoteLibraryEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#remotelibraryentrypoint)

***

### requirePluginMigrationRegistration

Re-exports [requirePluginMigrationRegistration](/docs/plugins/sdk/typescript/index.md#requirepluginmigrationregistration)

***

### RetryOptions

Re-exports [RetryOptions](/docs/plugins/sdk/typescript/plugin/index.md#retryoptions)

***

### RetryToken

Re-exports [RetryToken](/docs/plugins/sdk/typescript/db-execute/index.md#retrytoken)

***

### runAdapterBatch

Re-exports [runAdapterBatch](/docs/plugins/sdk/typescript/index.md#runadapterbatch)

***

### ScanLibraryParams

Re-exports [ScanLibraryParams](/docs/plugins/sdk/typescript/generated/index.md#scanlibraryparams)

***

### scanPage

Re-exports [scanPage](/docs/plugins/sdk/typescript/index.md#scanpage)

***

### schemaMigrationOp

Re-exports [schemaMigrationOp](/docs/plugins/sdk/typescript/plugin/index.md#schemamigrationop)

***

### SeriesEntry

Re-exports [SeriesEntry](/docs/plugins/sdk/typescript/generated/index.md#seriesentry)

***

### shouldSkipRemainingGuestWork

Re-exports [shouldSkipRemainingGuestWork](/docs/plugins/sdk/typescript/index.md#shouldskipremainingguestwork)

***

### SocketAutoResponsePair

Re-exports [SocketAutoResponsePair](/docs/plugins/sdk/typescript/env/index.md#socketautoresponsepair)

***

### SocketConnectOptions

Re-exports [SocketConnectOptions](/docs/plugins/sdk/typescript/env/index.md#socketconnectoptions)

***

### SocketMessageData

Re-exports [SocketMessageData](/docs/plugins/sdk/typescript/env/index.md#socketmessagedata)

***

### SocketMessageOk

Re-exports [SocketMessageOk](/docs/plugins/sdk/typescript/generated/index.md#socketmessageok)

***

### SocketsBinding

Re-exports [SocketsBinding](/docs/plugins/sdk/typescript/env/index.md#socketsbinding)

***

### SocketSendData

Re-exports [SocketSendData](/docs/plugins/sdk/typescript/env/index.md#socketsenddata)

***

### Source

Re-exports [Source](/docs/plugins/sdk/typescript/plugin/index.md#source-2)

***

### StatementResult

Re-exports [StatementResult](/docs/plugins/sdk/typescript/db-execute/index.md#statementresult)

***

### statementResultToD1Result

Re-exports [statementResultToD1Result](/docs/plugins/sdk/typescript/db-execute/index.md#statementresulttod1result)

***

### StorageBinding

Re-exports [StorageBinding](/docs/plugins/sdk/typescript/env/index.md#storagebinding)

***

### StorageEntrypoint

Re-exports [StorageEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#storageentrypoint)

***

### StorefrontEntrypoint

Re-exports [StorefrontEntrypoint](/docs/plugins/sdk/typescript/plugin/index.md#storefrontentrypoint)

***

### StorePage

Re-exports [StorePage](/docs/plugins/sdk/typescript/index.md#storepage)

***

### STREAM\_FRAME\_TARGET\_BYTES

Re-exports [STREAM_FRAME_TARGET_BYTES](/docs/plugins/sdk/typescript/index.md#stream_frame_target_bytes)

***

### streamsResults

Re-exports [streamsResults](/docs/plugins/sdk/typescript/index.md#streamsresults)

***

### toBridgeJson

Re-exports [toBridgeJson](/docs/plugins/sdk/typescript/plugin/index.md#tobridgejson)

***

### TRIGGER\_FAMILIES

Re-exports [TRIGGER_FAMILIES](/docs/plugins/sdk/typescript/plugin/index.md#trigger_families)

***

### TypedDbStatement

Re-exports [TypedDbStatement](/docs/plugins/sdk/typescript/db-execute/index.md#typeddbstatement)

***

### unpackEmbeddingVectors

Re-exports [unpackEmbeddingVectors](/docs/plugins/sdk/typescript/plugin/index.md#unpackembeddingvectors)

***

### WebhookDeliveredEvent

Re-exports [WebhookDeliveredEvent](/docs/plugins/sdk/typescript/env/index.md#webhookdeliveredevent)

***

### WebhookMessage

Re-exports [WebhookMessage](/docs/plugins/sdk/typescript/env/index.md#webhookmessage)

***

### WebhookPullOptions

Re-exports [WebhookPullOptions](/docs/plugins/sdk/typescript/env/index.md#webhookpulloptions)

***

### WebhookPullResult

Re-exports [WebhookPullResult](/docs/plugins/sdk/typescript/env/index.md#webhookpullresult)

***

### WebhooksBinding

Re-exports [WebhooksBinding](/docs/plugins/sdk/typescript/env/index.md#webhooksbinding)

***

### WireQueueBatch

Re-exports [WireQueueBatch](/docs/plugins/sdk/typescript/plugin/index.md#wirequeuebatch)

***

### WorkKind

Re-exports [WorkKind](/docs/plugins/sdk/typescript/abi/index.md#workkind)

***

### wrapPluginFromBinding

Re-exports [wrapPluginFromBinding](/docs/plugins/sdk/typescript/plugin/index.md#wrappluginfrombinding)

***

### wrapPluginFromNative

Re-exports [wrapPluginFromNative](/docs/plugins/sdk/typescript/plugin/index.md#wrappluginfromnative)

***

### WriteChunksError

Re-exports [WriteChunksError](/docs/plugins/sdk/typescript/db-execute/index.md#writechunkserror)

***

### writeChunksOperationId

Re-exports [writeChunksOperationId](/docs/plugins/sdk/typescript/db-execute/index.md#writechunksoperationid)

***

### WriteChunksOptions

Re-exports [WriteChunksOptions](/docs/plugins/sdk/typescript/db-execute/index.md#writechunksoptions)

***

### WriteOptions

Re-exports [WriteOptions](/docs/plugins/sdk/typescript/plugin/index.md#writeoptions)

***

### WriteProgress

Re-exports [WriteProgress](/docs/plugins/sdk/typescript/db-execute/index.md#writeprogress)
