Item class

Paquete:

@azure/cosmos

Se usa para realizar operaciones en un elemento específico.

Consulte Elementos para operaciones en todos los elementos; vea container.items.

Propiedades

container
id
url	Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

Métodos

delete<T>(RequestOptions)	Elimine el elemento. El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.
patch<T>(PatchRequestBody, RequestOptions)	Realice un JSONPatch en el elemento. El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.
read<T>(RequestOptions)	Lea la definición del elemento. El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla. Si el tipo, T, es una clase, no pasará typeof comparaciones, porque no tendrá un prototipo de coincidencia. Se recomienda usar solo interfaces. No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas. Ejemplo Uso del tipo personalizado para la respuesta interface TodoItem { title: string; done: bool; id: string; } let item: TodoItem; ({body: item} = await item.read<TodoItem>());
replace(ItemDefinition, RequestOptions)	Reemplace la definición del elemento. No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.
replace<T>(T, RequestOptions)	Reemplace la definición del elemento. El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla. No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Detalles de las propiedades

container

container: Container

Valor de propiedad

Container

id

id: string

Valor de propiedad

string

url

Devuelve una dirección URL de referencia al recurso. Se usa para vincular en Permisos.

string url

Valor de propiedad

string

Detalles del método

delete<T>(RequestOptions)

Elimine el elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

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

Parámetros

options

RequestOptions

Opciones adicionales para la solicitud

Devoluciones

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Realice un JSONPatch en el elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

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

Parámetros

body

PatchRequestBody

options

RequestOptions

Opciones adicionales para la solicitud

Devoluciones

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Lea la definición del elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla. Si el tipo, T, es una clase, no pasará typeof comparaciones, porque no tendrá un prototipo de coincidencia. Se recomienda usar solo interfaces.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

Ejemplo

Uso del tipo personalizado para la respuesta

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

Parámetros

options

RequestOptions

Opciones adicionales para la solicitud

Devoluciones

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Reemplace la definición del elemento.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

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

Parámetros

body

ItemDefinition

Definición con la que se va a reemplazar la definición del elemento existente.

options

RequestOptions

Opciones adicionales para la solicitud

Devoluciones

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Reemplace la definición del elemento.

El SDK no aplica necesariamente ningún tipo proporcionado, T. Puede obtener más o menos propiedades y es su lógica para aplicarla.

No hay ningún esquema establecido para los elementos JSON. Pueden contener cualquier número de propiedades personalizadas.

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

Parámetros

body

T

Definición con la que se va a reemplazar la definición del elemento existente.

options

RequestOptions

Opciones adicionales para la solicitud

Devoluciones

Promise<ItemResponse<T>>