Skip to content

Commit 6032daf

Browse files
committed
Update API reports
1 parent f63d34d commit 6032daf

File tree

1 file changed

+36
-2
lines changed

1 file changed

+36
-2
lines changed

common/api-review/data-connect.api.md

Lines changed: 36 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,6 +52,40 @@ export class DataConnect {
5252
setInitialized(): void;
5353
}
5454

55+
// @public
56+
export class DataConnectError extends FirebaseError {
57+
readonly code: DataConnectErrorCode;
58+
readonly message: string;
59+
readonly name: string;
60+
// (undocumented)
61+
toString(): string;
62+
}
63+
64+
// @public (undocumented)
65+
export type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
66+
67+
// @public
68+
export class DataConnectOperationError extends DataConnectError {
69+
readonly name: string;
70+
readonly response: DataConnectOperationResponse;
71+
}
72+
73+
// @public (undocumented)
74+
export interface DataConnectOperationErrorInfo {
75+
// (undocumented)
76+
readonly message: string;
77+
// (undocumented)
78+
readonly path: Array<string | number>;
79+
}
80+
81+
// @public (undocumented)
82+
export interface DataConnectOperationResponse {
83+
// (undocumented)
84+
readonly data?: Record<string, unknown> | null;
85+
// (undocumented)
86+
readonly errors: DataConnectOperationErrorInfo[];
87+
}
88+
5589
// @public
5690
export interface DataConnectOptions extends ConnectorConfig {
5791
// (undocumented)
@@ -67,7 +101,7 @@ export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
67101
// @public
68102
export interface DataConnectSubscription<Data, Variables> {
69103
// (undocumented)
70-
errCallback?: (e?: FirebaseError) => void;
104+
errCallback?: (e?: DataConnectError) => void;
71105
// (undocumented)
72106
unsubscribe: () => void;
73107
// (undocumented)
@@ -118,7 +152,7 @@ export interface MutationResult<Data, Variables> extends DataConnectResult<Data,
118152
export type OnCompleteSubscription = () => void;
119153

120154
// @public
121-
export type OnErrorSubscription = (err?: FirebaseError) => void;
155+
export type OnErrorSubscription = (err?: DataConnectError) => void;
122156

123157
// @public
124158
export type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;

0 commit comments

Comments
 (0)