Item class

  • 參考
套件:
@azure/cosmos

用來在特定專案上執行作業。

如需所有專案的作業，請參閱 專案 ;請參閱 container.items 。

屬性

container
id
url

傳回資源的參考 URL。 用於在 [許可權] 中連結。

方法

delete<T>(RequestOptions)

刪除專案。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。
patch<T>(PatchRequestBody, RequestOptions)

對專案執行 JSONPatch。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。
read<T>(RequestOptions)

讀取專案的定義。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。 如果類型 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)

取代專案的定義。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。

JSON 專案沒有設定的架構。 它們可能包含任意數目的自訂屬性。

屬性詳細資料

container 

container: Container

屬性值

Container

id 

id: string

屬性值

string

url

傳回資源的參考 URL。 用於在 [許可權] 中連結。

string url

屬性值

string

方法詳細資料

delete<T>(RequestOptions)

刪除專案。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。

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

參數

options
RequestOptions

要求的其他選項

傳回

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

對專案執行 JSONPatch。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。

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

參數

body
PatchRequestBody
options
RequestOptions

要求的其他選項

傳回

Promise<ItemResponse<T>>

read<T>(RequestOptions)

讀取專案的定義。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。 如果類型 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)

取代專案的定義。

SDK 不一定強制執行任何提供的型別 T。 您可以取得更多或更少的屬性，而且其取決於您的邏輯來強制執行它。

JSON 專案沒有設定的架構。 它們可能包含任意數目的自訂屬性。

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

參數

body

T

要取代現有 專案定義的定義。

options
RequestOptions

要求的其他選項

傳回

Promise<ItemResponse<T>>