functions.api.md

API Report File for "@firebase/functions"

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

import { FirebaseApp } from '@firebase/app';
import { FirebaseError } from '@firebase/util';

// @public
export function connectFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;

// @public
export interface Functions {
    app: FirebaseApp;
    customDomain: string | null;
    region: string;
}

// @public
export interface FunctionsError extends FirebaseError {
    readonly code: FunctionsErrorCode;
    readonly details?: unknown;
}

// @public
export type FunctionsErrorCode = `functions/${FunctionsErrorCodeCore}`;

// @public
export type FunctionsErrorCodeCore = 'ok' | 'cancelled' | 'unknown' | 'invalid-argument' | 'deadline-exceeded' | 'not-found' | 'already-exists' | 'permission-denied' | 'resource-exhausted' | 'failed-precondition' | 'aborted' | 'out-of-range' | 'unimplemented' | 'internal' | 'unavailable' | 'data-loss' | 'unauthenticated';

// @public
export function getFunctions(app?: FirebaseApp, regionOrCustomDomain?: string): Functions;

// @public
export type HttpsCallable<RequestData = unknown, ResponseData = unknown> = (data?: RequestData | null) => Promise<HttpsCallableResult<ResponseData>>;

// @public
export function httpsCallable<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, name: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

// @public
export function httpsCallableFromURL<RequestData = unknown, ResponseData = unknown>(functionsInstance: Functions, url: string, options?: HttpsCallableOptions): HttpsCallable<RequestData, ResponseData>;

// @public
export interface HttpsCallableOptions {
    limitedUseAppCheckTokens?: boolean;
    timeout?: number;
}

// @public
export interface HttpsCallableResult<ResponseData = unknown> {
    readonly data: ResponseData;
}