@@ -19,6 +19,7 @@ import { FirebaseError } from '@firebase/util';
1919
2020/**
2121 * An HttpsCallableResult wraps a single result from a function call.
22+ * @public
2223 */
2324export interface HttpsCallableResult < ResponseData = unknown > {
2425 readonly data : ResponseData ;
@@ -27,13 +28,15 @@ export interface HttpsCallableResult<ResponseData = unknown> {
2728/**
2829 * An HttpsCallable is a reference to a "callable" http trigger in
2930 * Google Cloud Functions.
31+ * @public
3032 */
3133export interface HttpsCallable < RequestData = unknown , ResponseData = unknown > {
3234 ( data ?: RequestData | null ) : Promise < HttpsCallableResult < ResponseData > > ;
3335}
3436
3537/**
3638 * HttpsCallableOptions specify metadata about how calls should be executed.
39+ * @public
3740 */
3841export interface HttpsCallableOptions {
3942 timeout ?: number ; // in millis
@@ -42,6 +45,7 @@ export interface HttpsCallableOptions {
4245/**
4346 * `Functions` represents a Functions instance, and is a required argument for
4447 * all Functions operations.
48+ * @public
4549 */
4650export interface Functions {
4751 /**
@@ -100,6 +104,7 @@ export interface Functions {
100104 * - 'data-loss': Unrecoverable data loss or corruption.
101105 * - 'unauthenticated': The request does not have valid authentication
102106 * credentials for the operation.
107+ * @public
103108 */
104109export type FunctionsErrorCode =
105110 | 'ok'
@@ -120,6 +125,10 @@ export type FunctionsErrorCode =
120125 | 'data-loss'
121126 | 'unauthenticated' ;
122127
128+ /**
129+ * An error returned by the Firebase Functions client SDK.
130+ * @public
131+ */
123132export interface FunctionsError extends FirebaseError {
124133 /**
125134 * A standard error code that will be returned to the client. This also
0 commit comments