firebase-functions

constructor

constructor(before: {}, after: {});

property after

after: {};

property before

before: {};

method fromJSON

static fromJSON: <T>(json: ChangeJson, customizer?: (x: any) => T) => Change<T>;

• Factory method for creating a Change from JSON and an optional customizer function to be applied to both the before and the after fields.

method fromObjects

static fromObjects: <T>(before: T, after: T) => Change<T>;

• Factory method for creating a Change from a before object and an after object.

property data

data: T;

• Information about this specific event.

property id

id: string;

• A globally unique ID for this event.

property source

source: string;

• The resource that published this event.

property specversion

readonly specversion: '1.0';

• Version of the CloudEvents spec for this event.

property subject

subject?: string;

• The resource, provided by source, that this event relates to.

property time

time: string;

• When this event occurred.

property type

type: string;

• The type of event that this represents.

method run

run: (event: EventType) => any | Promise<any>;

• The callback passed to the CloudFunction constructor. Use run to test a function.

  Parameter event

  The parsed event to handle.

  Returns

  Any return value. Cloud Functions awaits any promise before shutting down your function. Resolved return values are only used for unit testing purposes.

  Modifiers

  • @beta

call signature

(raw: CloudEvent<unknown>): any | Promise<any>;

property channel

channel?: string;

• The name of the channel where the function receives events.

property eventFilterPathPatterns

eventFilterPathPatterns?: Record<string, string | Expression<string>>;

• Filters events based on path pattern matching on the CloudEvents attributes.

  Similar to eventFilters, but supports wildcard patterns for flexible matching where * matches any single path segment, ** matches zero or more path segments, and {param} captures a path segment as a parameter

property eventFilters

eventFilters?: Record<string, string | Expression<string>>;

• Filters events based on exact matches on the CloudEvents attributes.

  Each key-value pair represents an attribute name and its required value for exact matching. Events must match all specified filters to trigger the function.

property eventType

eventType?: string;

• Type of the event.

property region

region?: string | Expression<string> | ResetValue;

• Region of the EventArc trigger.

property retry

retry?: boolean | Expression<boolean> | ResetValue;

• Whether failed executions should be delivered again.

property serviceAccount

serviceAccount?: string | Expression<string> | ResetValue;

• The service account that EventArc should use to invoke this function. Requires the P4SA to have ActAs permission on this service account.

property concurrency

concurrency?: number | Expression<number> | ResetValue;

• Number of requests a function can serve at once.

  Remarks

  Can be applied only to functions running on Cloud Functions (2nd gen)). A value of null restores the default concurrency (80 when CPU >= 1, 1 otherwise). Concurrency cannot be set to any value other than 1 if cpu is less than 1. The maximum value for concurrency is 1,000.

property cpu

cpu?: number | 'gcf_gen1';

• Fractional number of CPUs to allocate to a function.

  Remarks

  Defaults to 1 for functions with <= 2GB RAM and increases for larger memory sizes. This is different from the defaults when using the gcloud utility and is different from the fixed amount assigned in Cloud Functions (1st gen). To revert to the CPU amounts used in gcloud or in Cloud Functions (1st gen), set this to the value "gcf_gen1"

property enforceAppCheck

enforceAppCheck?: boolean;

• Determines whether Firebase App Check is enforced. Defaults to false.

  Remarks

  When true, requests with invalid tokens autorespond with a 401 (Unauthorized) error. When false, requests with invalid tokens set event.app to undefined.

property ingressSettings

ingressSettings?: IngressSetting | ResetValue;

• Ingress settings which control where this function can be called from.

property invoker

invoker?: 'public' | 'private' | string | string[];

• Invoker to set access control on HTTPS functions.

property labels

labels?: Record<string, string>;

• User labels to set on the function.

property maxInstances

maxInstances?: number | Expression<number> | ResetValue;

• Max number of instances that can be running in parallel.

property memory

memory?: MemoryOption | Expression<number> | ResetValue;

• Amount of memory to allocate to a function.

property minInstances

minInstances?: number | Expression<number> | ResetValue;

• Minimum number of actual instances to be running at a given time.

  Remarks

  Instances are billed for memory allocation and 10% of CPU allocation while idle.

property omit

omit?: boolean | Expression<boolean>;

• If true, do not deploy or emulate this function.

property preserveExternalChanges

preserveExternalChanges?: boolean;

• Controls whether function configuration modified outside of function source is preserved. Defaults to false.

  Remarks

  When setting configuration available in an underlying platform that is not yet available in the Firebase SDK for Cloud Functions, we recommend setting preserveExternalChanges to true. Otherwise, when Google releases a new version of the SDK with support for the missing configuration, your function's manually configured setting may inadvertently be wiped out.

property region

region?: SupportedRegion | string | Expression<string> | ResetValue;

• Region where functions should be deployed.

property secrets

secrets?: (string | SecretParam)[];

property serviceAccount

serviceAccount?: string | Expression<string> | ResetValue;

• Specific service account for the function to run as.

property timeoutSeconds

timeoutSeconds?: number | Expression<number> | ResetValue;

• Timeout for the function in seconds, possible values are 0 to 540. HTTPS functions can specify a higher timeout.

  Remarks

  The minimum timeout for a 2nd gen function is 1s. The maximum timeout for a function depends on the type of function: Event handling functions have a maximum timeout of 540s (9 minutes). HTTPS and callable functions have a maximum timeout of 3,600s (1 hour). Task queue functions have a maximum timeout of 1,800s (30 minutes).

property vpcConnector

vpcConnector?: string | Expression<string> | ResetValue;

• Connect a function to a specified VPC connector.

property vpcConnectorEgressSettings

vpcConnectorEgressSettings?: VpcEgressSetting | ResetValue;

• Egress settings for VPC connector.

function onAlertPublished

onAlertPublished: {
    <T extends { '@type': string } = any>(
        alertType: AlertType,
        handler: (event: AlertEvent<T>) => any | Promise<any>
    ): CloudFunction<AlertEvent<T>>;
    <T extends { '@type': string } = any>(
        options: FirebaseAlertOptions,
        handler: (event: AlertEvent<T>) => any
    ): CloudFunction<AlertEvent<T>>;
};

• Declares a function that can handle Firebase Alerts from CloudEvents.

  Parameter alertType

  the alert type or Firebase Alert function configuration.

  Parameter handler

  a function that can handle the Firebase Alert inside a CloudEvent.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle Firebase Alerts from CloudEvents.

  Parameter options

  the alert type and other options for this cloud function.

  Parameter handler

  a function that can handle the Firebase Alert inside a CloudEvent.

type AlertType

type AlertType =
    | 'crashlytics.newFatalIssue'
    | 'crashlytics.newNonfatalIssue'
    | 'crashlytics.regression'
    | 'crashlytics.stabilityDigest'
    | 'crashlytics.velocity'
    | 'crashlytics.newAnrIssue'
    | 'billing.planUpdate'
    | 'billing.planAutomatedUpdate'
    | 'appDistribution.newTesterIosDevice'
    | 'appDistribution.inAppFeedback'
    | 'performance.threshold'
    | string;

• The underlying alert type of the Firebase Alerts provider.

function onInAppFeedbackPublished

onInAppFeedbackPublished: {
    (
        handler: (
            event: AppDistributionEvent<InAppFeedbackPayload>
        ) => any | Promise<any>
    ): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
    (
        appId: string,
        handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any
    ): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
    (
        opts: AppDistributionOptions,
        handler: (event: AppDistributionEvent<InAppFeedbackPayload>) => any
    ): CloudFunction<AppDistributionEvent<InAppFeedbackPayload>>;
};

• Declares a function that can handle receiving new in-app feedback from a tester.

  Parameter handler

  Event handler which is run every time new feedback is received.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle receiving new in-app feedback from a tester.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler which is run every time new feedback is received.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle receiving new in-app feedback from a tester.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler which is run every time new feedback is received.

  Returns

  A function that you can export and deploy.

function onNewTesterIosDevicePublished

onNewTesterIosDevicePublished: {
    (
        handler: (
            event: AppDistributionEvent<NewTesterDevicePayload>
        ) => any | Promise<any>
    ): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;
    (
        appId: string,
        handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any
    ): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;
    (
        opts: AppDistributionOptions,
        handler: (event: AppDistributionEvent<NewTesterDevicePayload>) => any
    ): CloudFunction<AppDistributionEvent<NewTesterDevicePayload>>;
};

• Declares a function that can handle adding a new tester iOS device.

  Parameter handler

  Event handler which is run every time a new tester iOS device is added.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle adding a new tester iOS device.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler which is run every time a new tester iOS device is added.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle adding a new tester iOS device.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler which is run every time a new tester iOS device is added.

  Returns

  A function that you can export and deploy.

function onPlanAutomatedUpdatePublished

onPlanAutomatedUpdatePublished: {
    (
        handler: (
            event: BillingEvent<PlanAutomatedUpdatePayload>
        ) => any | Promise<any>
    ): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;
    (
        opts: options.EventHandlerOptions,
        handler: (event: BillingEvent<PlanAutomatedUpdatePayload>) => any
    ): CloudFunction<BillingEvent<PlanAutomatedUpdatePayload>>;
};

• Declares a function that can handle an automated billing plan update event.

  Parameter handler

  Event handler which is run every time an automated billing plan update occurs.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle an automated billing plan update event.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler which is run every time an automated billing plan update occurs.

  Returns

  A function that you can export and deploy.

function onPlanUpdatePublished

onPlanUpdatePublished: {
    (
        handler: (event: BillingEvent<PlanUpdatePayload>) => any | Promise<any>
    ): CloudFunction<BillingEvent<PlanUpdatePayload>>;
    (
        opts: options.EventHandlerOptions,
        handler: (event: BillingEvent<PlanUpdatePayload>) => any
    ): CloudFunction<BillingEvent<PlanUpdatePayload>>;
};

• Declares a function that can handle a billing plan update event.

  Parameter handler

  Event handler which is run every time a billing plan is updated.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a billing plan update event.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler which is run every time a billing plan is updated.

  Returns

  A function that you can export and deploy.

function onNewAnrIssuePublished

onNewAnrIssuePublished: {
    (
        handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<NewAnrIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewAnrIssuePayload>>;
};

• Declares a function that can handle a new Application Not Responding issue published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new Application Not Responding issue published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new Application Not Responding issue published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a new Application Not Responding issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

function onNewFatalIssuePublished

onNewFatalIssuePublished: {
    (
        handler: (
            event: CrashlyticsEvent<NewFatalIssuePayload>
        ) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<NewFatalIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewFatalIssuePayload>>;
};

• Declares a function that can handle a new fatal issue published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a new fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new fatal issue published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a new fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new fatal issue published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a new fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

function onNewNonfatalIssuePublished

onNewNonfatalIssuePublished: {
    (
        handler: (
            event: CrashlyticsEvent<NewNonfatalIssuePayload>
        ) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<NewNonfatalIssuePayload>) => any
    ): CloudFunction<CrashlyticsEvent<NewNonfatalIssuePayload>>;
};

• Declares a function that can handle a new non-fatal issue published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a new fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new non-fatal issue published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a new non-fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a new non-fatal issue published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a new non-fatal issue is published to Crashlytics.

  Returns

  A function that you can export and deploy.

function onRegressionAlertPublished

onRegressionAlertPublished: {
    (
        handler: (
            event: CrashlyticsEvent<RegressionAlertPayload>
        ) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any
    ): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<RegressionAlertPayload>) => any
    ): CloudFunction<CrashlyticsEvent<RegressionAlertPayload>>;
};

• Declares a function that can handle a regression alert published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a regression alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a regression alert published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a regression alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a regression alert published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a regression alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.

function onStabilityDigestPublished

onStabilityDigestPublished: {
    (
        handler: (
            event: CrashlyticsEvent<StabilityDigestPayload>
        ) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any
    ): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<StabilityDigestPayload>) => any
    ): CloudFunction<CrashlyticsEvent<StabilityDigestPayload>>;
};

• Declares a function that can handle a stability digest published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a stability digest is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a stability digest published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a stability digest is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a stability digest published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a stability digest is published to Crashlytics.

  Returns

  A function that you can export and deploy.

function onVelocityAlertPublished

onVelocityAlertPublished: {
    (
        handler: (
            event: CrashlyticsEvent<VelocityAlertPayload>
        ) => any | Promise<any>
    ): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
    (
        appId: string,
        handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any
    ): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
    (
        opts: CrashlyticsOptions,
        handler: (event: CrashlyticsEvent<VelocityAlertPayload>) => any
    ): CloudFunction<CrashlyticsEvent<VelocityAlertPayload>>;
};

• Declares a function that can handle a velocity alert published to Crashlytics.

  Parameter handler

  Event handler that is triggered when a velocity alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a velocity alert published to Crashlytics.

  Parameter appId

  A specific application the handler will trigger on.

  Parameter handler

  Event handler that is triggered when a velocity alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.

• Declares a function that can handle a velocity alert published to Crashlytics.

  Parameter opts

  Options that can be set on the function.

  Parameter handler

  Event handler that is triggered when a velocity alert is published to Crashlytics.

  Returns

  A function that you can export and deploy.