firebase-functions package

The 2nd gen API for Cloud Functions for Firebase. This SDK supports deep imports. For example, the namespace pubsub is available at firebase-functions/v2 or is directly importable from firebase-functions/v2/pubsub.

Functions

Classes

Interfaces

Namespaces

Variables

Type Aliases

onInit()

Registers a callback that should be run when in a production environment before executing any functions code. Calling this function more than once leads to undefined behavior.

Signature:

export declare function onInit(callback: () => unknown): void;

Parameters

Returns:

void

requiresAPI()

Declare that this project requires a specific Google Cloud API to be enabled.

Signature:

export declare function requiresAPI(api: GoogleCloudApi, reason?: string): void;

Parameters

Returns:

void

requiresRole()

Declares that this codebase requires the specified IAM role to operate. When deployed, the Firebase CLI will automatically provision a managed service account with this role and attach it to all functions in this codebase.

Signature:

export declare function requiresRole(role: Role): void;

Parameters

Returns:

void

setGlobalOptions()

Sets default options for all functions written using the 2nd gen SDK.

Signature:

export declare function setGlobalOptions(options: GlobalOptions): void;

Parameters

Returns:

void

app

Signature:

app: {
    setEmulatedAdminApp: typeof setEmulatedAdminApp;
}

config

functions.config() has been removed in firebase-functions v7. Migrate to environment parameters using the params module immediately. Migration guide: https://firebase.google.com/docs/functions/config-env#migrate-config

Signature:

config: never

logger

Logger object containing all logging methods.

Mockable for testing purposes.

Signature:

logger: {
    write: typeof write;
    debug: typeof debug;
    log: typeof log;
    info: typeof info;
    warn: typeof warn;
    error: typeof error;
}

traceContext

Signature:

traceContext: AsyncLocalStorage<TraceContext>

IngressSetting

List of available options for IngressSettings.

Signature:

export type IngressSetting = "ALLOW_ALL" | "ALLOW_INTERNAL_ONLY" | "ALLOW_INTERNAL_AND_GCLB";

MemoryOption

List of available memory options supported by Cloud Functions.

Signature:

export type MemoryOption = "128MiB" | "256MiB" | "512MiB" | "1GiB" | "2GiB" | "4GiB" | "8GiB" | "16GiB" | "32GiB";

ParamsOf

A type that maps all parameter capture groups into keys of a record. For example, ParamsOf<"users/{uid}"> is { uid: string } ParamsOf<"users/{uid}/logs/{log}"> is { uid: string; log: string } ParamsOf<"some/static/data"> is {}

For flexibility reasons, ParamsOf is Record<string, string>

Signature:

export type ParamsOf<PathPattern extends string | Expression<string>> = PathPattern extends Expression<string> ? Record<string, string> : string extends PathPattern ? Record<string, string> : {
    [Key in VarName<Split<NullSafe<Exclude<PathPattern, Expression<string>>>, "/">[number]>]: string;
};

Role

A TypeScript literal type for IAM roles to provide compile-time validation.

Signature:

export type Role = `roles/${string}.${string}` | `projects/${string}/roles/${string}` | `organizations/${string}/roles/${string}`;

SupportedRegion

List of all regions supported by Cloud Functions (2nd gen).

Signature:

export type SupportedRegion = "asia-east1" | "asia-northeast1" | "asia-northeast2" | "europe-north1" | "europe-west1" | "europe-west4" | "us-central1" | "us-east1" | "us-east4" | "us-west1" | "asia-east2" | "asia-northeast3" | "asia-southeast1" | "asia-southeast2" | "asia-south1" | "australia-southeast1" | "europe-central2" | "europe-west2" | "europe-west3" | "europe-west6" | "northamerica-northeast1" | "southamerica-east1" | "us-west2" | "us-west3" | "us-west4";

VpcEgressSetting

List of available options for VpcConnectorEgressSettings.

Signature:

export type VpcEgressSetting = "PRIVATE_RANGES_ONLY" | "ALL_TRAFFIC";