firebase-admin.functions package

o serviço Firebase Functions.

Funções

Função	Descrição
getFunctions(app) (em inglês)	Recebe o serviço Functions para o app padrão ou um determinado app.getFunctions() pode ser chamado sem argumentos para acessar o serviço Functions do app padrão ou como getFunctions(app) para acessar o serviço Functions associado a um app específico.

Aulas

Turma	Descrição
Funções	A interface do serviço Functions do Firebase.
Fila de tarefas	A interface TaskQueue.

Interfaces

Interface	Descrição
AbsoluteDelivery (link em inglês)	Interface que representa opções de tarefas com entrega absoluta.
DelayDelivery	Interface que representa opções de tarefas com entrega atrasada.
DemoExperimental (link em inglês)	Tipo que representa opções de tarefas experimentais (Beta).

Aliases de tipos

Tipo de alias	Descrição
DeliverySchedule (link em inglês)	Tipo que representa as opções de programação de entrega. DeliverySchedule é um tipo de união dos tipos DelayDelivery e AbsoluteDelivery.
TaskOptions	Tipo que representa as opções de tarefa.

getFunctions(app)

Recebe o serviço Functions para o app padrão ou um determinado app.

getFunctions() pode ser chamado sem argumentos para acessar o serviço Functions do app padrão ou como getFunctions(app) para acessar o serviço Functions associado a um app específico.

Assinatura:

export declare function getFunctions(app?: App): Functions;

Parâmetros

Parâmetro	Tipo	Descrição
app	App	App opcional para retornar o serviço Functions. Caso não seja fornecido, o serviço Functions padrão será retornado.

Retorna:

Funções

O serviço Functions padrão, se nenhum app for fornecido, ou o serviço Functions associado ao app fornecido.

Exemplo 1

// Get the `Functions` service for the default app
const defaultFunctions = getFunctions();

Exemplo 2

// Get the `Functions` service for a given app
const otherFunctions = getFunctions(otherApp);

Programação de entrega

Tipo que representa as opções de programação de entrega. DeliverySchedule é um tipo de união dos tipos DelayDelivery e AbsoluteDelivery.

Assinatura:

export type DeliverySchedule = DelayDelivery | AbsoluteDelivery;

TaskOptions

Tipo que representa as opções de tarefa.

Assinatura:

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