firebase-admin.functions package

serviço do Firebase Functions.

Funções

Função Descrição
getFunctions(app) (link em inglês) Recebe o serviço Functions para o app padrão ou para 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.

Classes

Turma Descrição
Funções A interface de serviço Functions do Firebase.
TaskQueue (em inglês) A interface TaskQueue.

Interfaces

Interface Descrição
CompleteDelivery (em inglês) Interface que representa opções de tarefa com entrega absoluta.
DelayDelivery (link em inglês) Interface que representa opções de tarefa com entrega atrasada.
Execução Experimental Tipo que representa as opções de tarefa experimentais (Beta).

Aliases de tipos

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

getFunctions(app)

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

O 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. Se não for informado, 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 CompleteDelivery.

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>;
};