Item class

  • Referentie
Pakket:
@azure/cosmos

Wordt gebruikt voor het uitvoeren van bewerkingen op een specifiek item.

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

Eigenschappen

container
id
url

Retourneert een verwijzings-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 dit 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 dit 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 dit af te dwingen. Als het type T een klasse is, slaagt het niet voor typeof vergelijkingen, omdat het geen overeenkomende prototype heeft. Het wordt aanbevolen om alleen interfaces te gebruiken.

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

Voorbeeld

Aangepast type voor antwoord gebruiken

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 vast schema 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 dit af te dwingen.

Er is geen vast schema 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 verwijzings-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 dit 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 dit 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 dit af te dwingen. Als het type T een klasse is, slaagt het niet voor typeof vergelijkingen, omdat het geen overeenkomende prototype heeft. Het wordt aanbevolen om alleen interfaces te gebruiken.

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

Voorbeeld

Aangepast type voor antwoord gebruiken

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 vast schema 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 om de definitie van het bestaande item door te vervangen.

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 dit af te dwingen.

Er is geen vast schema 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 om de definitie van het bestaande item door te vervangen.

options
RequestOptions

Aanvullende opties voor de aanvraag

Retouren

Promise<ItemResponse<T>>