Udostępnij za pośrednictwem

Item class

  • Odwołanie
Pakiet:
@azure/cosmos

Służy do wykonywania operacji na określonym elemencie.

Zobacz Elementy dotyczące operacji na wszystkich elementach; zobacz container.items.

Właściwości

container
id
url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w uprawnieniach.

Metody

delete<T>(RequestOptions)

Usuń element.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.
patch<T>(PatchRequestBody, RequestOptions)

Wykonaj element JSONPatch.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.
read<T>(RequestOptions)

Przeczytaj definicję elementu.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić. Jeśli typ T jest klasą, nie będzie przekazywać typeof porównań, ponieważ nie będzie miał prototypu dopasowania. Zaleca się używanie tylko interfejsów.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Używanie typu niestandardowego dla odpowiedzi

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

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

Zastąp definicję elementu.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.
replace<T>(T, RequestOptions)

Zastąp definicję elementu.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.

Szczegóły właściwości

container 

container: Container

Wartość właściwości

Container

id 

id: string

Wartość właściwości

string

url

Zwraca adres URL odwołania do zasobu. Służy do łączenia w uprawnieniach.

string url

Wartość właściwości

string

Szczegóły metody

delete<T>(RequestOptions)

Usuń element.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.

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

Parametry

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Wykonaj element JSONPatch.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.

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

Parametry

body
PatchRequestBody
options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Przeczytaj definicję elementu.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić. Jeśli typ T jest klasą, nie będzie przekazywać typeof porównań, ponieważ nie będzie miał prototypu dopasowania. Zaleca się używanie tylko interfejsów.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.

Przykład

Używanie typu niestandardowego dla odpowiedzi

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

Parametry

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Zastąp definicję elementu.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.

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

Parametry

body
ItemDefinition

Definicja zastępująca definicję istniejącego elementu.

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Zastąp definicję elementu.

Każdy podany typ, T, nie musi być wymuszany przez zestaw SDK. Możesz uzyskać więcej lub mniej właściwości i jest to do logiki, aby ją wymusić.

Nie ma ustawionego schematu dla elementów JSON. Mogą one zawierać dowolną liczbę właściwości niestandardowych.

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

Parametry

body

T

Definicja zastępująca definicję istniejącego elementu.

options
RequestOptions

Dodatkowe opcje żądania

Zwraca

Promise<ItemResponse<T>>