Back to Firebase Js Sdk

FunctionsError class

docs-devsite/functions.functionserror.md

12.12.11.7 KB
Original Source

Project: /docs/reference/js/_project.yaml Book: /docs/reference/_book.yaml page_type: reference

{% comment %} DO NOT EDIT THIS FILE! This is generated by the JS SDK team, and any local changes will be overwritten. Changes should be made in the source code at https://github.com/firebase/firebase-js-sdk {% endcomment %}

FunctionsError class

An error returned by the Firebase Functions client SDK.

See FunctionsErrorCode for full documentation of codes.

<b>Signature:</b>

typescript
export declare class FunctionsError extends FirebaseError 

<b>Extends:</b> FirebaseError

Constructors

ConstructorModifiersDescription
(constructor)(code, message, details)Constructs a new instance of the <code>FunctionsError</code> class.

Properties

PropertyModifiersTypeDescription
detailsunknownAdditional details to be converted to JSON and included in the error response.

FunctionsError.(constructor)

Constructs a new instance of the FunctionsError class.

<b>Signature:</b>

typescript
constructor(
    code: FunctionsErrorCode, message?: string, 
    details?: unknown);

Parameters

ParameterTypeDescription
codeFunctionsErrorCode
messagestring
detailsunknown

FunctionsError.details

Additional details to be converted to JSON and included in the error response.

<b>Signature:</b>

typescript
readonly details?: unknown;