Skip to content

Commit b4c1b5d

Browse files
committed
Fix types
1 parent 71541ae commit b4c1b5d

File tree

2 files changed

+14
-5
lines changed

2 files changed

+14
-5
lines changed

common/api-review/functions-exp.api.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,7 +14,7 @@ export interface Functions {
1414
region: string;
1515
}
1616

17-
// @public (undocumented)
17+
// @public
1818
export interface FunctionsError extends FirebaseError {
1919
readonly code: FunctionsErrorCode;
2020
readonly details?: unknown;
@@ -27,9 +27,9 @@ export type FunctionsErrorCode = 'ok' | 'cancelled' | 'unknown' | 'invalid-argum
2727
export function getFunctions(app: FirebaseApp, regionOrCustomDomain?: string): Functions;
2828

2929
// @public
30-
export interface HttpsCallable {
30+
export interface HttpsCallable<RequestData = unknown, ResponseData = unknown> {
3131
// (undocumented)
32-
(data?: {} | null): Promise<HttpsCallableResult>;
32+
(data?: RequestData | null): Promise<HttpsCallableResult<ResponseData>>;
3333
}
3434

3535
// @public
@@ -42,9 +42,9 @@ export interface HttpsCallableOptions {
4242
}
4343

4444
// @public
45-
export interface HttpsCallableResult {
45+
export interface HttpsCallableResult<ResponseData = unknown> {
4646
// (undocumented)
47-
readonly data: unknown;
47+
readonly data: ResponseData;
4848
}
4949

5050
// @public

packages-exp/functions-exp/src/public-types.ts

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -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
*/
2324
export 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
*/
3133
export 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
*/
3841
export 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
*/
4650
export 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
*/
104109
export 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+
*/
123132
export interface FunctionsError extends FirebaseError {
124133
/**
125134
* A standard error code that will be returned to the client. This also

0 commit comments

Comments
 (0)