Поделиться через

Item class

  • Ссылка
Пакет:
@azure/cosmos

Используется для выполнения операций с определенным элементом.

Сведения об операциях со всеми элементами см. в элементов; см. container.items.

Свойства

container
id
url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

Методы

delete<T>(RequestOptions)

Удалите элемент.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.
patch<T>(PatchRequestBody, RequestOptions)

Выполните JSONPatch для элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.
read<T>(RequestOptions)

Чтение определения элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее. Если тип, T, является классом, он не будет передавать typeof сравнения, так как он не будет иметь прототип соответствия. Рекомендуется использовать только интерфейсы.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.

пример

Использование пользовательского типа для ответа

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

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

Замените определение элемента.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.
replace<T>(T, RequestOptions)

Замените определение элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.

Сведения о свойстве

container 

container: Container

Значение свойства

Container

id 

id: string

Значение свойства

string

url

Возвращает URL-адрес ссылки для ресурса. Используется для связывания в разрешениях.

string url

Значение свойства

string

Сведения о методе

delete<T>(RequestOptions)

Удалите элемент.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.

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

Параметры

options
RequestOptions

Дополнительные параметры запроса

Возвращаемое значение

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Выполните JSONPatch для элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.

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

Параметры

body
PatchRequestBody
options
RequestOptions

Дополнительные параметры запроса

Возвращаемое значение

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Чтение определения элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее. Если тип, T, является классом, он не будет передавать typeof сравнения, так как он не будет иметь прототип соответствия. Рекомендуется использовать только интерфейсы.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.

пример

Использование пользовательского типа для ответа

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

Параметры

options
RequestOptions

Дополнительные параметры запроса

Возвращаемое значение

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Замените определение элемента.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.

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

Параметры

body
ItemDefinition

Определение для замены существующего элементаопределением.

options
RequestOptions

Дополнительные параметры запроса

Возвращаемое значение

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Замените определение элемента.

Любой предоставленный тип T не обязательно применяется пакетом SDK. Вы можете получить более или менее свойства, и это до вашей логики, чтобы применить ее.

Для элементов JSON не задана схема. Они могут содержать любое количество настраиваемых свойств.

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

Параметры

body

T

Определение для замены существующего элементаопределением.

options
RequestOptions

Дополнительные параметры запроса

Возвращаемое значение

Promise<ItemResponse<T>>