Item class

  • Referencia
Csomag:
@azure/cosmos

Műveletek végrehajtására szolgál egy adott elemen.

Lásd: Elemek az összes elemen végzett műveletekhez; lásd: container.items.

Tulajdonságok

container
id
url

Egy hivatkozási URL-címet ad vissza az erőforrásnak. Az engedélyek csatolásához használatos.

Metódusok

delete<T>(RequestOptions)

Törölje az elemet.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.
patch<T>(PatchRequestBody, RequestOptions)

JSONPatch végrehajtása az elemen.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.
read<T>(RequestOptions)

Olvassa el az elem definícióját.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt. Ha a típus (T) egy osztály, nem fog megfeleltetni typeof az összehasonlításoknak, mert nem lesz egyező prototípusa. Javasoljuk, hogy csak interfészeket használjon.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Példa

Egyéni típus használata a válaszhoz

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

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

Cserélje le az elem definícióját.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.
replace<T>(T, RequestOptions)

Cserélje le az elem definícióját.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Tulajdonság adatai

container 

container: Container

Tulajdonság értéke

Container

id 

id: string

Tulajdonság értéke

string

url

Egy hivatkozási URL-címet ad vissza az erőforrásnak. Az engedélyek csatolásához használatos.

string url

Tulajdonság értéke

string

Metódus adatai

delete<T>(RequestOptions)

Törölje az elemet.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

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

Paraméterek

options
RequestOptions

További lehetőségek a kérelemhez

Válaszok

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

JSONPatch végrehajtása az elemen.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

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

Paraméterek

body
PatchRequestBody
options
RequestOptions

További lehetőségek a kérelemhez

Válaszok

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Olvassa el az elem definícióját.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt. Ha a típus (T) egy osztály, nem fog megfeleltetni typeof az összehasonlításoknak, mert nem lesz egyező prototípusa. Javasoljuk, hogy csak interfészeket használjon.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

Példa

Egyéni típus használata a válaszhoz

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>>

Paraméterek

options
RequestOptions

További lehetőségek a kérelemhez

Válaszok

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Cserélje le az elem definícióját.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

body
ItemDefinition

A meglévő elem definícióját lecserélő definíció.

options
RequestOptions

További lehetőségek a kérelemhez

Válaszok

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Cserélje le az elem definícióját.

Az SDK nem feltétlenül kényszeríti ki a megadott típust (T). Előfordulhat, hogy több vagy kevesebb tulajdonságot kap, és a logikán múlik, hogy kikényszerítse azt.

A JSON-elemekhez nincs beállított séma. Ezek tetszőleges számú egyéni tulajdonságot tartalmazhatnak.

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

Paraméterek

body

T

A meglévő elem definícióját lecserélő definíció.

options
RequestOptions

További lehetőségek a kérelemhez

Válaszok

Promise<ItemResponse<T>>