Skip to content

Commit c616528

Browse files
committed
Updated data connect API
1 parent 1ce98e6 commit c616528

File tree

1 file changed

+8
-33
lines changed

1 file changed

+8
-33
lines changed

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

+8-33
Original file line numberDiff line numberDiff line change
@@ -52,36 +52,6 @@ export class DataConnect {
5252
setInitialized(): void;
5353
}
5454

55-
// @public
56-
export class DataConnectError extends FirebaseError {
57-
readonly code: DataConnectErrorCode;
58-
}
59-
60-
// @public (undocumented)
61-
export type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error' | 'unauthorized';
62-
63-
// @public
64-
export class DataConnectOperationError extends DataConnectError {
65-
/* Excluded from this release type: name */
66-
readonly response: DataConnectOperationResponse;
67-
}
68-
69-
// @public (undocumented)
70-
export interface DataConnectOperationErrorInfo {
71-
// (undocumented)
72-
readonly message: string;
73-
// (undocumented)
74-
readonly path: Array<string | number>;
75-
}
76-
77-
// @public (undocumented)
78-
export interface DataConnectOperationResponse {
79-
// (undocumented)
80-
readonly data?: Record<string, unknown> | null;
81-
// (undocumented)
82-
readonly errors: DataConnectOperationErrorInfo[];
83-
}
84-
8555
// @public
8656
export interface DataConnectOptions extends ConnectorConfig {
8757
// (undocumented)
@@ -97,7 +67,7 @@ export interface DataConnectResult<Data, Variables> extends OpResult<Data> {
9767
// @public
9868
export interface DataConnectSubscription<Data, Variables> {
9969
// (undocumented)
100-
errCallback?: (e?: DataConnectError) => void;
70+
errCallback?: (e?: FirebaseError) => void;
10171
// (undocumented)
10272
unsubscribe: () => void;
10373
// (undocumented)
@@ -113,6 +83,9 @@ export function executeMutation<Data, Variables>(mutationRef: MutationRef<Data,
11383
// @public
11484
export function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
11585

86+
// @public (undocumented)
87+
export const fdcSymbol: unique symbol;
88+
11689
// @public
11790
export function getDataConnect(options: ConnectorConfig): DataConnect;
11891

@@ -148,13 +121,15 @@ export interface MutationResult<Data, Variables> extends DataConnectResult<Data,
148121
export type OnCompleteSubscription = () => void;
149122

150123
// @public
151-
export type OnErrorSubscription = (err?: DataConnectError) => void;
124+
export type OnErrorSubscription = (err?: FirebaseError) => void;
152125

153126
// @public
154127
export type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
155128

156129
// @public (undocumented)
157-
export interface OperationRef<_Data, Variables> {
130+
export interface OperationRef<Data, Variables> {
131+
// (undocumented)
132+
[fdcSymbol]?: Data;
158133
// (undocumented)
159134
dataConnect: DataConnect;
160135
// (undocumented)

0 commit comments

Comments
 (0)