Item class

  • Referensi
Paket:
@azure/cosmos

Digunakan untuk melakukan operasi pada item tertentu.

Lihat Item untuk operasi pada semua item; lihat container.items.

Properti

container
id
url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.

Metode

delete<T>(RequestOptions)

Hapus item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.
patch<T>(PatchRequestBody, RequestOptions)

Lakukan JSONPatch pada item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.
read<T>(RequestOptions)

Baca definisi item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya. Jika jenis, T, adalah kelas, itu tidak akan melewati typeof perbandingan, karena tidak akan memiliki prototipe yang cocok. Disarankan untuk hanya menggunakan antarmuka.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

Contoh

Menggunakan jenis kustom untuk respons

interface TodoItem {
  title: string;
  done: bool;
  id: string;
}

let item: TodoItem;
({body: item} = await item.read<TodoItem>());
replace(ItemDefinition, RequestOptions)

Ganti definisi item.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.
replace<T>(T, RequestOptions)

Ganti definisi item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

Detail Properti

container 

container: Container

Nilai Properti

Container

id 

id: string

Nilai Properti

string

url

Mengembalikan URL referensi ke sumber daya. Digunakan untuk menautkan di Izin.

string url

Nilai Properti

string

Detail Metode

delete<T>(RequestOptions)

Hapus item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.

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

Parameter

options
RequestOptions

Opsi tambahan untuk permintaan

Mengembalikan

Promise<ItemResponse<T>>

patch<T>(PatchRequestBody, RequestOptions)

Lakukan JSONPatch pada item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.

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

Parameter

body
PatchRequestBody
options
RequestOptions

Opsi tambahan untuk permintaan

Mengembalikan

Promise<ItemResponse<T>>

read<T>(RequestOptions)

Baca definisi item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya. Jika jenis, T, adalah kelas, itu tidak akan melewati typeof perbandingan, karena tidak akan memiliki prototipe yang cocok. Disarankan untuk hanya menggunakan antarmuka.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

Contoh

Menggunakan jenis kustom untuk respons

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

Parameter

options
RequestOptions

Opsi tambahan untuk permintaan

Mengembalikan

Promise<ItemResponse<T>>

replace(ItemDefinition, RequestOptions)

Ganti definisi item.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

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

Parameter

body
ItemDefinition

Definisi untuk mengganti definisi Item yang ada dengan.

options
RequestOptions

Opsi tambahan untuk permintaan

Mengembalikan

Promise<ItemResponse<ItemDefinition>>

replace<T>(T, RequestOptions)

Ganti definisi item.

Jenis apa pun yang disediakan, T, belum tentu diberlakukan oleh SDK. Anda mungkin mendapatkan lebih banyak atau kurang properti dan terserah logika Anda untuk menegakkannya.

Tidak ada skema yang ditetapkan untuk item JSON. Mereka mungkin berisi sejumlah properti kustom.

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

Parameter

body

T

Definisi untuk mengganti definisi Item yang ada dengan.

options
RequestOptions

Opsi tambahan untuk permintaan

Mengembalikan

Promise<ItemResponse<T>>