Item class

  • Referens
Paket:
@azure/cosmos

Används för att utföra åtgärder på ett visst objekt.

Se Objekt för åtgärder på alla objekt; se container.items.

Egenskaper

container
id
url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

Metoder

delete<T>(RequestOptions)

Ta bort objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.
patch<T>(PatchRequestBody, RequestOptions)

Utför en JSONPatch på objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.
read<T>(RequestOptions)

Läs objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den. Om typen T är en klass godkänns typeof inte jämförelser eftersom den inte har någon matchningsprototyp. Vi rekommenderar att du bara använder gränssnitt.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Exempel

Använda anpassad typ för svar

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());
replace(ItemDefinition, RequestOptions)

Ersätt objektets definition.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.
replace<T>(T, RequestOptions)

Ersätt objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Egenskapsinformation

container 

container: Container

Egenskapsvärde

Container

id 

id: string

Egenskapsvärde

string

url

Returnerar en referens-URL till resursen. Används för länkning i Behörigheter.

string url

Egenskapsvärde

string

Metodinformation

delete<T>(RequestOptions)

Ta bort objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

function delete<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parametrar

options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Utför en JSONPatch på objektet.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

function patch<T>(body: PatchRequestBody, options?: RequestOptions): Promise<ItemResponse<T>>

Parametrar

body
PatchRequestBody
options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Läs objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den. Om typen T är en klass godkänns typeof inte jämförelser eftersom den inte har någon matchningsprototyp. Vi rekommenderar att du bara använder gränssnitt.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

Exempel

Använda anpassad typ för svar

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());

function read<T>(options?: RequestOptions): Promise<ItemResponse<T>>

Parametrar

options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Ersätt objektets definition.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

function replace(body: ItemDefinition, options?: RequestOptions): Promise<ItemResponse<ItemDefinition>>

Parametrar

body
ItemDefinition

Definitionen som ska ersätta det befintliga objektets definition med.

options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Ersätt objektets definition.

Alla angivna typer, T, framtvingas inte nödvändigtvis av SDK:t. Du kan få fler eller färre egenskaper och det är upp till din logik att tillämpa den.

Det finns inget schema för JSON-objekt. De kan innehålla valfritt antal anpassade egenskaper.

function replace<T>(body: T, options?: RequestOptions): Promise<ItemResponse<T>>

Parametrar

body

T

Definitionen som ska ersätta det befintliga objektets definition med.

options
RequestOptions

Ytterligare alternativ för begäran

Returer

Promise<ItemResponse<T>>