Item class

  • Riferimento
Pacchetto:
@azure/cosmos

Utilizzato per eseguire operazioni su un elemento specifico.

Vedere Elementi per operazioni su tutti gli elementi; vedere container.items.

Proprietà

container
id
url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

Metodi

delete<T>(RequestOptions)

Eliminare l'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.
patch<T>(PatchRequestBody, RequestOptions)

Eseguire un jsonPatch sull'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.
read<T>(RequestOptions)

Leggere la definizione dell'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla. Se il tipo, T, è una classe, non passerà typeof confronti, perché non avrà un prototipo corrispondente. È consigliabile usare solo le interfacce.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

Esempio

Uso del tipo personalizzato per la risposta

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

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

Sostituire la definizione dell'elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.
replace<T>(T, RequestOptions)

Sostituire la definizione dell'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

Dettagli proprietà

container 

container: Container

Valore della proprietà

Container

id 

id: string

Valore della proprietà

string

url

Restituisce un URL di riferimento alla risorsa. Usato per il collegamento in Autorizzazioni.

string url

Valore della proprietà

string

Dettagli metodo

delete<T>(RequestOptions)

Eliminare l'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.

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

Parametri

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Eseguire un jsonPatch sull'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.

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

Parametri

body
PatchRequestBody
options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Leggere la definizione dell'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla. Se il tipo, T, è una classe, non passerà typeof confronti, perché non avrà un prototipo corrispondente. È consigliabile usare solo le interfacce.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

Esempio

Uso del tipo personalizzato per la risposta

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

Parametri

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Sostituire la definizione dell'elemento.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

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

Parametri

body
ItemDefinition

Definizione con cui sostituire la definizione dell'elemento esistente.

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Sostituire la definizione dell'elemento.

Qualsiasi tipo specificato, T, non è necessariamente applicato dall'SDK. È possibile ottenere più o meno proprietà ed è fino alla logica per applicarla.

Non esiste uno schema impostato per gli elementi JSON. Possono contenere un numero qualsiasi di proprietà personalizzate.

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

Parametri

body

T

Definizione con cui sostituire la definizione dell'elemento esistente.

options
RequestOptions

Opzioni aggiuntive per la richiesta

Restituisce

Promise<ItemResponse<T>>