Item class

container: Container

プロパティ値

id: string

プロパティ値

リソースへの参照 URL を返します。 [アクセス許可] でリンクするために使用されます。

string url

プロパティ値

アイテムを削除します。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

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

パラメーター

戻り値

項目に対して JSONPatch を実行します。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

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

パラメーター

戻り値

項目の定義を読み取る。

指定された型 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>>

パラメーター

戻り値

項目の定義を置き換えます。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

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

パラメーター

戻り値

項目の定義を置き換えます。

指定された型 T は、必ずしも SDK によって適用されるとは限りません。 多かれ少なかれプロパティを取得する場合があり、それを適用するのはロジック次第です。

JSON 項目のスキーマは設定されていません。 任意の数のカスタム プロパティを含む場合があります。

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

パラメーター

戻り値