functions library

Classes

FirebaseFunctions
Access to Firebase Functions components

Extension Types

AdditionalUserInfo
The additional user info component of the auth event context
AppCheckData
The interface for AppCheck tokens verified in Callable functions
AuthBlockingEvent
Defines the auth event for 2nd gen blocking events
AuthData
The interface for Auth tokens verified in Callable functions
AuthEventContext
Defines the auth event context for blocking events
AuthMultiFactorInfo
Interface representing the common properties of a user-enrolled second factor.
AuthMultiFactorSettings
The multi-factor related properties for the current user, if available.
AuthUserInfo
User info that is part of the AuthUserRecord.
AuthUserMetadata
Additional metadata about the user.
AuthUserRecord
The UserRecord passed to auth blocking functions from the identity platform.
BeforeCreateResponse
The handler response type for beforeCreate blocking events
BeforeSignInResponse
The handler response type for beforeSignIn blocking events
BlockingOptions
All function options plus idToken, accessToken, and refreshToken.
CallableOptions
Options that can be set on a callable HTTPS function.
CallableRequest
The request used to call a callable function.
CloudEvent
A CloudEventBase is the base of a cross-platform format for encoding a serverless event. For more information, see https://github.com/cloudevents/spec. @typeParam T - The type of the event data. @beta
Credential
The credential component of the auth event context
DocumentOptions
DocumentOptions extend EventHandlerOptions with provided document and optional database and namespace.
FirebaseFunctionsFirestore
The Firebase Functions Firestore namespace
FirebaseFunctionsHttps
The Firebase Functions HTTPS namespace
FirebaseFunctionsIdentity
The Firebase Functions Identity namespace
FirestoreAuthEvent
A FirestoreEvent with auth context
FirestoreEvent
A CloudEvent that contains a DocumentSnapshot or a Change
HttpsOptions
Options that can be set on an onRequest HTTPS function.
Request
An express request with the wire format representation of the request body.

Properties

resetValue String
Special configuration value to reset configuration to platform default.
no setter