Sdílet prostřednictvím

Item class

  • Reference
Balíček:
@azure/cosmos

Slouží k provádění operací s konkrétní položkou.

Operace se všemi položkami najdete v tématu Položky; viz container.items.

Vlastnosti

container
id
url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

Metody

delete<T>(RequestOptions)

Odstraňte položku.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.
patch<T>(PatchRequestBody, RequestOptions)

Proveďte u položky jsonPatch.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.
read<T>(RequestOptions)

Přečtěte si definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila. Pokud typ T je třída, nepřejde typeof porovnání, protože nebude mít prototyp shody. Doporučujeme používat pouze rozhraní.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad

Použití vlastního typu pro odpověď

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

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

Nahraďte definici položky.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.
replace<T>(T, RequestOptions)

Nahraďte definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

Podrobnosti vlastnosti

container 

container: Container

Hodnota vlastnosti

Container

id 

id: string

Hodnota vlastnosti

string

url

Vrátí adresu URL odkazu na prostředek. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete<T>(RequestOptions)

Odstraňte položku.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

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

Parametry

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Proveďte u položky jsonPatch.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

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

Parametry

body
PatchRequestBody
options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Přečtěte si definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila. Pokud typ T je třída, nepřejde typeof porovnání, protože nebude mít prototyp shody. Doporučujeme používat pouze rozhraní.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

příklad

Použití vlastního typu pro odpověď

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

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Nahraďte definici položky.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

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

Parametry

body
ItemDefinition

Definice, která má nahradit existující Itemdefinici.

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Nahraďte definici položky.

Jakýkoli zadaný typ T nemusí sada SDK vynucovat. Můžete získat více nebo méně vlastností a je na vaší logice, aby ji vynutila.

Pro položky JSON neexistuje žádné schéma sady. Mohou obsahovat libovolný počet vlastních vlastností.

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

Parametry

body

T

Definice, která má nahradit existující Itemdefinici.

options
RequestOptions

Další možnosti požadavku

Návraty

Promise<ItemResponse<T>>