veritatisdoloremque
Version:
Monorepo for the Firebase JavaScript SDK
57 lines (41 loc) • 1.81 kB
Markdown
> Do not edit this file. It is a report generated by [API Extractor](https://api-extractor.com/).
```ts
import { FirebaseApp } from '@firebase/app-exp';
import { FirebaseError } from '@firebase/util';
// @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 = '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 interface HttpsCallable<RequestData = unknown, ResponseData = unknown> {
// (undocumented)
(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 interface HttpsCallableOptions {
// (undocumented)
timeout?: number;
}
// @public
export interface HttpsCallableResult<ResponseData = unknown> {
// (undocumented)
readonly data: ResponseData;
}
// @public
export function useFunctionsEmulator(functionsInstance: Functions, host: string, port: number): void;
// (No @packageDocumentation comment for this package)
```