Interface ICosmosItem

A structural subset of the SDK Item handle — one document addressed by its id and partition key.

Since

0.2.0

interface ICosmosItem {
    delete(
        options?: CosmosRequestOptions,
    ): Promise<CosmosItemResponse<Record<string, unknown>>>;
    patch(
        operations: readonly CosmosPatchOperation[],
    ): Promise<CosmosItemResponse<Record<string, unknown>>>;
    read(): Promise<CosmosItemResponse<Record<string, unknown>>>;
    replace(
        body: Record<string, unknown>,
        options?: CosmosRequestOptions,
    ): Promise<CosmosItemResponse<Record<string, unknown>>>;
}

Index

Methods

delete patch read replace

Methods

delete

delete(
options?: CosmosRequestOptions,
): Promise<CosmosItemResponse<Record<string, unknown>>>
Deletes the document, throwing a 404 when it does not exist.
Parameters
- Optionaloptions: CosmosRequestOptions
Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The delete envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:305

patch

patch(
operations: readonly CosmosPatchOperation[],
): Promise<CosmosItemResponse<Record<string, unknown>>>
Applies a patch to the document server-side.
Parameters
- operations: readonly CosmosPatchOperation[]
  The set operations to apply
Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The patched document envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:296

read

read(): Promise<CosmosItemResponse<Record<string, unknown>>>
Reads the document.

Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The envelope; resource is undefined when the document does not exist under this partition key (a 404 does NOT throw)
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:276

replace

replace(
body: Record<string, unknown>,
options?: CosmosRequestOptions,
): Promise<CosmosItemResponse<Record<string, unknown>>>
Replaces the document wholesale.
Parameters
- body: Record<string, unknown>
  The full replacement document
- Optionaloptions: CosmosRequestOptions
  Per-request options (the IfMatch guard)
Returns Promise<CosmosItemResponse<Record<string, unknown>>>
The replaced document envelope
- Defined in packages/database-plugin/src/adapters/cosmos/cosmos-client-types.ts:285