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

Определение, которым необходимо заменить существующее определение Item.

options
RequestOptions

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

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

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

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

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

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

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

Параметры

body

T

Определение, которым необходимо заменить существующее определение Item.

options
RequestOptions

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

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

Promise<ItemResponse<T>>