firebase-admin.functions.api.md

API Report File for "firebase-admin.functions"

Do not edit this file. It is a report generated by API Extractor.

import { Agent } from 'http';

// @public
export interface AbsoluteDelivery {
    // @alpha (undocumented)
    scheduleDelaySeconds?: never;
    scheduleTime?: Date;
}

// @public
export interface DelayDelivery {
    scheduleDelaySeconds?: number;
    // @alpha (undocumented)
    scheduleTime?: never;
}

// @public
export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

// @public
export class Functions {
    // Warning: (ae-forgotten-export) The symbol "App" needs to be exported by the entry point index.d.ts
    //
    // (undocumented)
    readonly app: App;
    taskQueue<Args = Record<string, any>>(functionName: string, extensionId?: string): TaskQueue<Args>;
}

// @public
export function getFunctions(app?: App): Functions;

// @public
export type TaskOptions = DeliverySchedule & TaskOptionsExperimental & {
    dispatchDeadlineSeconds?: number;
    id?: string;
    headers?: Record<string, string>;
};

// @public
export interface TaskOptionsExperimental {
    // @beta
    uri?: string;
}

// @public
export class TaskQueue<Args = Record<string, any>> {
    delete(id: string): Promise<void>;
    enqueue(data: Args, opts?: TaskOptions): Promise<void>;
}