@@ -19,6 +19,7 @@ import { FirebaseError } from '@firebase/util';
19
19
20
20
/**
21
21
* An HttpsCallableResult wraps a single result from a function call.
22
+ * @public
22
23
*/
23
24
export interface HttpsCallableResult < ResponseData = unknown > {
24
25
readonly data : ResponseData ;
@@ -27,13 +28,15 @@ export interface HttpsCallableResult<ResponseData = unknown> {
27
28
/**
28
29
* An HttpsCallable is a reference to a "callable" http trigger in
29
30
* Google Cloud Functions.
31
+ * @public
30
32
*/
31
33
export interface HttpsCallable < RequestData = unknown , ResponseData = unknown > {
32
34
( data ?: RequestData | null ) : Promise < HttpsCallableResult < ResponseData > > ;
33
35
}
34
36
35
37
/**
36
38
* HttpsCallableOptions specify metadata about how calls should be executed.
39
+ * @public
37
40
*/
38
41
export interface HttpsCallableOptions {
39
42
timeout ?: number ; // in millis
@@ -42,6 +45,7 @@ export interface HttpsCallableOptions {
42
45
/**
43
46
* `Functions` represents a Functions instance, and is a required argument for
44
47
* all Functions operations.
48
+ * @public
45
49
*/
46
50
export interface Functions {
47
51
/**
@@ -100,6 +104,7 @@ export interface Functions {
100
104
* - 'data-loss': Unrecoverable data loss or corruption.
101
105
* - 'unauthenticated': The request does not have valid authentication
102
106
* credentials for the operation.
107
+ * @public
103
108
*/
104
109
export type FunctionsErrorCode =
105
110
| 'ok'
@@ -120,6 +125,10 @@ export type FunctionsErrorCode =
120
125
| 'data-loss'
121
126
| 'unauthenticated' ;
122
127
128
+ /**
129
+ * An error returned by the Firebase Functions client SDK.
130
+ * @public
131
+ */
123
132
export interface FunctionsError extends FirebaseError {
124
133
/**
125
134
* A standard error code that will be returned to the client. This also
0 commit comments