Item class

  • Referência
Pacote:
@azure/cosmos

Usado para executar operações em um item específico.

Consulte Itens para operações em todos os itens; consulte container.items.

Propriedades

container
id
url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

Métodos

delete<T>(RequestOptions)

Exclua o item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.
patch<T>(PatchRequestBody, RequestOptions)

Execute um JSONPatch no item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.
read<T>(RequestOptions)

Leia a definição do item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la. Se o tipo, T, for uma classe, ele não passará por typeof comparações, pois não terá um protótipo de correspondência. É recomendável usar apenas interfaces.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Usando o tipo personalizado para resposta

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

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

Substitua a definição do item.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.
replace<T>(T, RequestOptions)

Substitua a definição do item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Detalhes da propriedade

container 

container: Container

Valor da propriedade

Container

id 

id: string

Valor da propriedade

string

url

Retorna uma URL de referência para o recurso. Usado para vinculação em Permissões.

string url

Valor da propriedade

string

Detalhes do método

delete<T>(RequestOptions)

Exclua o item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.

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

Parâmetros

options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Execute um JSONPatch no item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.

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

Parâmetros

body
PatchRequestBody
options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Leia a definição do item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la. Se o tipo, T, for uma classe, ele não passará por typeof comparações, pois não terá um protótipo de correspondência. É recomendável usar apenas interfaces.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

Exemplo

Usando o tipo personalizado para resposta

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

Parâmetros

options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Substitua a definição do item.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

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

Parâmetros

body
ItemDefinition

A definição pela qual substituir a definição do Item existente.

options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Substitua a definição do item.

Qualquer tipo fornecido, T, não é necessariamente imposto pelo SDK. Você pode obter mais ou menos propriedades e cabe à sua lógica aplicá-la.

Não há nenhum esquema definido para itens JSON. Eles podem conter qualquer número de propriedades personalizadas.

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

Parâmetros

body

T

A definição pela qual substituir a definição do Item existente.

options
RequestOptions

Opções adicionais para a solicitação

Retornos

Promise<ItemResponse<T>>