Item class

  • Reference
Balíček:
@azure/cosmos

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

Viz Položky pro operace se všemi položkami; viz container.items.

Vlastnosti

container
id
url

Vrátí referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

Metody

delete<T>(RequestOptions)

Odstraňte položku.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.
patch<T>(PatchRequestBody, RequestOptions)

Proveďte jsonPatch u položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.
read<T>(RequestOptions)

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

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice. Pokud je typ T třída, neprojde typeof porovnáním, protože nebude mít odpovídající prototyp. Doporučuje se používat pouze rozhraní.

Pro položky JSON neexistuje žádné nastavené schéma. 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é nastavené schéma. Mohou obsahovat libovolný počet vlastních vlastností.
replace<T>(T, RequestOptions)

Nahraďte definici položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

Pro položky JSON neexistuje žádné nastavené schéma. 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í referenční adresu URL prostředku. Používá se pro propojení v oprávněních.

string url

Hodnota vlastnosti

string

Podrobnosti metody

delete<T>(RequestOptions)

Odstraňte položku.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

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

Parametry

options
RequestOptions

Další možnosti žádosti

Návraty

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Proveďte jsonPatch u položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

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

Parametry

body
PatchRequestBody
options
RequestOptions

Další možnosti žádosti

Návraty

Promise<ItemResponse<T>>

read<T>(RequestOptions)

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

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice. Pokud je typ T třída, neprojde typeof porovnáním, protože nebude mít odpovídající prototyp. Doporučuje se používat pouze rozhraní.

Pro položky JSON neexistuje žádné nastavené schéma. 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 žádosti

Návraty

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Nahraďte definici položky.

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

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

Parametry

body
ItemDefinition

Definice, kterou chcete nahradit definicí existující položky.

options
RequestOptions

Další možnosti žádosti

Návraty

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Nahraďte definici položky.

Sada SDK nemusí vynucovat žádný zadaný typ T. Můžete získat více nebo méně vlastností a vynucování je na vaší logice.

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

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

Parametry

body

T

Definice, kterou chcete nahradit definicí existující položky.

options
RequestOptions

Další možnosti žádosti

Návraty

Promise<ItemResponse<T>>