Error eksplisit yang dapat ditampilkan dari pengendali untuk mengirim error ke klien yang memanggil fungsi.
Tanda Tangan:
export declare class HttpsError extends Error
Memperluas: Error
Konstruktor
| Konstruktor | Pengubah | Deskripsi |
|---|---|---|
| (konstruktor)(kode, pesan, detail) | Membuat instance baru dari class HttpsError |
Properti
| Properti | Pengubah | Jenis | Deskripsi |
|---|---|---|---|
| kode | FunctionsErrorCode | Kode error standar yang akan ditampilkan ke klien. Kode ini juga menentukan kode status HTTP respons, seperti yang ditentukan dalam code.proto. | |
| detail | tidak diketahui | Data tambahan yang akan dikonversi ke JSON dan disertakan dalam respons error. | |
| httpErrorCode | {i>HttpErrorCode<i} | Representasi format kabel untuk kode error yang diberikan. |
Metode
| Metode | Pengubah | Deskripsi |
|---|---|---|
| toJSON() | Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini. |
auth.HttpsError.(konstruktor)
Membuat instance baru dari class HttpsError
Tanda Tangan:
constructor(code: FunctionsErrorCode, message: string, details?: unknown);
Parameter
| Parameter | Jenis | Deskripsi |
|---|---|---|
| kode | FunctionsErrorCode | |
| message | string | |
| detail | tidak diketahui |
auth.HttpsError.code
Kode error standar yang akan ditampilkan ke klien. Kode ini juga menentukan kode status HTTP respons, seperti yang ditentukan dalam code.proto.
Tanda Tangan:
readonly code: FunctionsErrorCode;
auth.HttpsError.details
Data tambahan yang akan dikonversi ke JSON dan disertakan dalam respons error.
Tanda Tangan:
readonly details: unknown;
{i>auth.HttpsError.httpErrorCode<i}
Representasi format kabel untuk kode error yang diberikan.
Tanda Tangan:
readonly httpErrorCode: HttpErrorCode;
{i>auth.HttpsError.toJSON()<i}
Menampilkan representasi JSON-serial yang dapat diserialisasi dari objek ini.
Tanda Tangan:
toJSON(): HttpErrorWireFormat;
Hasil:
{i>HttpErrorWireFormat<i}