Skip to content

Latest commit

 

History

History
77 lines (59 loc) · 2.6 KB

functions.api.md

File metadata and controls

77 lines (59 loc) · 2.6 KB

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';// @publicexportfunctionconnectFunctionsEmulator(functionsInstance: Functions,host: string,port: number): void;// @publicexportinterfaceFunctions{app: FirebaseApp;customDomain: string|null;region: string;}// @publicexportclassFunctionsErrorextendsFirebaseError{constructor(code: FunctionsErrorCodeCore,message?: string,details?: unknown);readonlydetails?: unknown;}// @publicexporttypeFunctionsErrorCode= `functions/${FunctionsErrorCodeCore}`;// @publicexporttypeFunctionsErrorCodeCore='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';// @publicexportfunctiongetFunctions(app?: FirebaseApp,regionOrCustomDomain?: string): Functions;// @publicexportinterfaceHttpsCallable<RequestData=unknown,ResponseData=unknown,StreamData=unknown>{// (undocumented)(data?: RequestData|null): Promise<HttpsCallableResult<ResponseData>>;// (undocumented)stream: (data?: RequestData|null,options?: HttpsCallableStreamOptions)=>Promise<HttpsCallableStreamResult<ResponseData,StreamData>>;}// @publicexportfunctionhttpsCallable<RequestData=unknown,ResponseData=unknown,StreamData=unknown>(functionsInstance: Functions,name: string,options?: HttpsCallableOptions): HttpsCallable<RequestData,ResponseData,StreamData>;// @publicexportfunctionhttpsCallableFromURL<RequestData=unknown,ResponseData=unknown,StreamData=unknown>(functionsInstance: Functions,url: string,options?: HttpsCallableOptions): HttpsCallable<RequestData,ResponseData,StreamData>;// @publicexportinterfaceHttpsCallableOptions{limitedUseAppCheckTokens?: boolean;timeout?: number;}// @publicexportinterfaceHttpsCallableResult<ResponseData=unknown>{readonlydata: ResponseData;}// @publicexportinterfaceHttpsCallableStreamOptions{limitedUseAppCheckTokens?: boolean;signal?: AbortSignal;}// @publicexportinterfaceHttpsCallableStreamResult<ResponseData=unknown,StreamData=unknown>{// (undocumented)readonlydata: Promise<ResponseData>;// (undocumented)readonlystream: AsyncIterable<StreamData>;}
close