Delen via

Item class

  • Referentie
Pakket:
@azure/cosmos

Wordt gebruikt om bewerkingen uit te voeren op een specifiek item.

Zie items voor bewerkingen op alle items; zie container.items.

Eigenschappen

container
id
url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

Methoden

delete<T>(RequestOptions)

Verwijder het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.
patch<T>(PatchRequestBody, RequestOptions)

Voer een JSONPatch uit op het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.
read<T>(RequestOptions)

Lees de definitie van het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen. Als het type, T, een klasse is, wordt deze niet doorgegeven typeof vergelijkingen, omdat het geen prototype van een overeenkomst heeft. Het is raadzaam om alleen interfaces te gebruiken.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

voorbeeld van

Aangepast type gebruiken voor antwoord

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

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

Vervang de definitie van het item.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.
replace<T>(T, RequestOptions)

Vervang de definitie van het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

Eigenschapdetails

container 

container: Container

Waarde van eigenschap

Container

id 

id: string

Waarde van eigenschap

string

url

Retourneert een referentie-URL naar de resource. Wordt gebruikt voor het koppelen in machtigingen.

string url

Waarde van eigenschap

string

Methodedetails

delete<T>(RequestOptions)

Verwijder het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

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

Parameters

options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Voer een JSONPatch uit op het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

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

Parameters

body
PatchRequestBody
options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Lees de definitie van het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen. Als het type, T, een klasse is, wordt deze niet doorgegeven typeof vergelijkingen, omdat het geen prototype van een overeenkomst heeft. Het is raadzaam om alleen interfaces te gebruiken.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

voorbeeld van

Aangepast type gebruiken voor antwoord

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

Parameters

options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Vervang de definitie van het item.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

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

Parameters

body
ItemDefinition

De definitie voor het vervangen van de bestaande itemdefinitie door.

options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Vervang de definitie van het item.

Elk opgegeven type, T, wordt niet noodzakelijkerwijs afgedwongen door de SDK. Mogelijk krijgt u meer of minder eigenschappen en is het aan uw logica om deze af te dwingen.

Er is geen schema ingesteld voor JSON-items. Ze kunnen een willekeurig aantal aangepaste eigenschappen bevatten.

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

Parameters

body

T

De definitie voor het vervangen van de bestaande itemdefinitie door.

options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<T>>