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