FunctionsError class
Stay organized with collections
Save and categorize content based on your preferences.
An error returned by the Firebase Functions client SDK.
See FunctionsErrorCode for full documentation of codes.
Signature:
export declare class FunctionsError extends FirebaseError
Extends: FirebaseError
Constructors
Properties
Property |
Modifiers |
Type |
Description |
details |
|
unknown |
Additional details to be converted to JSON and included in the error response. |
FunctionsError.(constructor)
Constructs a new instance of the FunctionsError
class.
Signature:
constructor(
code: FunctionsErrorCode, message?: string,
details?: unknown);
Parameters
FunctionsError.details
Additional details to be converted to JSON and included in the error response.
Signature:
readonly details?: unknown;
Except as otherwise noted, the content of this page is licensed under the Creative Commons Attribution 4.0 License, and code samples are licensed under the Apache 2.0 License. For details, see the Google Developers Site Policies. Java is a registered trademark of Oracle and/or its affiliates.
Last updated 2024-10-22 UTC.
[null,null,["Last updated 2024-10-22 UTC."],[],[],null,["# FunctionsError class\n\nAn error returned by the Firebase Functions client SDK.\n\nSee [FunctionsErrorCode](./functions.md#functionserrorcode) for full documentation of codes.\n\n**Signature:** \n\n export declare class FunctionsError extends FirebaseError \n\n**Extends:** [FirebaseError](./util.firebaseerror.md#firebaseerror_class)\n\nConstructors\n------------\n\n| Constructor | Modifiers | Description |\n|--------------------------------------------------------------------------------------------------|-----------|----------------------------------------------------------|\n| [(constructor)(code, message, details)](./functions.functionserror.md#functionserrorconstructor) | | Constructs a new instance of the `FunctionsError` class. |\n\nProperties\n----------\n\n| Property | Modifiers | Type | Description |\n|----------------------------------------------------------------|-----------|---------|--------------------------------------------------------------------------------|\n| [details](./functions.functionserror.md#functionserrordetails) | | unknown | Additional details to be converted to JSON and included in the error response. |\n\nFunctionsError.(constructor)\n----------------------------\n\nConstructs a new instance of the `FunctionsError` class.\n\n**Signature:** \n\n constructor(\n code: FunctionsErrorCode, message?: string, \n details?: unknown);\n\n#### Parameters\n\n| Parameter | Type | Description |\n|-----------|-------------------------------------------------------------|-------------|\n| code | [FunctionsErrorCode](./functions.md#functionserrorcodecore) | |\n| message | string | |\n| details | unknown | |\n\nFunctionsError.details\n----------------------\n\nAdditional details to be converted to JSON and included in the error response.\n\n**Signature:** \n\n readonly details?: unknown;"]]