Skip to content

Latest commit

 

History

History
284 lines (229 loc) · 8.34 KB

data-connect.api.md

File metadata and controls

284 lines (229 loc) · 8.34 KB

API Report File for "@firebase/data-connect"

Do not edit this file. It is a report generated by API Extractor.

import{AppCheckInternalComponentName}from'@firebase/app-check-interop-types';import{FirebaseApp}from'@firebase/app';import{FirebaseAuthInternalName}from'@firebase/auth-interop-types';import{FirebaseError}from'@firebase/util';import{LogLevelString}from'@firebase/logger';import{Provider}from'@firebase/component';// @publicexporttypeCallerSdkType='Base'|'Generated'|'TanstackReactCore'|'GeneratedReact'|'TanstackAngularCore'|'GeneratedAngular';// @public (undocumented)exportconstCallerSdkTypeEnum: {readonlyBase: "Base";readonlyGenerated: "Generated";readonlyTanstackReactCore: "TanstackReactCore";readonlyGeneratedReact: "GeneratedReact";readonlyTanstackAngularCore: "TanstackAngularCore";readonlyGeneratedAngular: "GeneratedAngular";};// @public (undocumented)exporttypeCode=DataConnectErrorCode;// @public (undocumented)exportconstCode: {OTHER: DataConnectErrorCode;ALREADY_INITIALIZED: DataConnectErrorCode;NOT_INITIALIZED: DataConnectErrorCode;NOT_SUPPORTED: DataConnectErrorCode;INVALID_ARGUMENT: DataConnectErrorCode;PARTIAL_ERROR: DataConnectErrorCode;UNAUTHORIZED: DataConnectErrorCode;};// @publicexportfunctionconnectDataConnectEmulator(dc: DataConnect,host: string,port?: number,sslEnabled?: boolean): void;// @publicexportinterfaceConnectorConfig{// (undocumented)connector: string;// (undocumented)location: string;// (undocumented)service: string;}// @publicexportclassDataConnect{constructor(app: FirebaseApp,dataConnectOptions: DataConnectOptions,_authProvider: Provider<FirebaseAuthInternalName>,_appCheckProvider: Provider<AppCheckInternalComponentName>);// (undocumented)readonlyapp: FirebaseApp;// (undocumented)enableEmulator(transportOptions: TransportOptions): void;// (undocumented)getSettings(): ConnectorConfig;// (undocumented)isEmulator: boolean;// (undocumented)setInitialized(): void;}// @publicexportclassDataConnectErrorextendsFirebaseError{/* Excluded from this release type: name */constructor(code: Code,message: string);}// @public (undocumented)exporttypeDataConnectErrorCode='other'|'already-initialized'|'not-initialized'|'not-supported'|'invalid-argument'|'partial-error'|'unauthorized';// @publicexportclassDataConnectOperationErrorextendsDataConnectError{/* Excluded from this release type: name */readonlyresponse: DataConnectOperationFailureResponse;}// @public (undocumented)exportinterfaceDataConnectOperationFailureResponse{// (undocumented)readonlydata?: Record<string,unknown>|null;// (undocumented)readonlyerrors: DataConnectOperationFailureResponseErrorInfo[];}// @public (undocumented)exportinterfaceDataConnectOperationFailureResponseErrorInfo{// (undocumented)readonlymessage: string;// (undocumented)readonlypath: Array<string|number>;}// @publicexportinterfaceDataConnectOptionsextendsConnectorConfig{// (undocumented)projectId: string;}// @public (undocumented)exportinterfaceDataConnectResult<Data,Variables>extendsOpResult<Data>{// (undocumented)ref: OperationRef<Data,Variables>;}// @publicexportinterfaceDataConnectSubscription<Data,Variables>{// (undocumented)errCallback?: (e?: DataConnectError)=>void;// (undocumented)unsubscribe: ()=>void;// (undocumented)userCallback: OnResultSubscription<Data,Variables>;}// @public (undocumented)exporttypeDataSource=typeofSOURCE_CACHE|typeofSOURCE_SERVER;// @publicexportfunctionexecuteMutation<Data,Variables>(mutationRef: MutationRef<Data,Variables>): MutationPromise<Data,Variables>;// @publicexportfunctionexecuteQuery<Data,Variables>(queryRef: QueryRef<Data,Variables>): QueryPromise<Data,Variables>;// @publicexportfunctiongetDataConnect(options: ConnectorConfig): DataConnect;// @publicexportfunctiongetDataConnect(app: FirebaseApp,options: ConnectorConfig): DataConnect;// @public (undocumented)exportconstMUTATION_STR="mutation";// @publicexportinterfaceMutationPromise<Data,Variables>extendsPromise<MutationResult<Data,Variables>>{}// @public (undocumented)exportinterfaceMutationRef<Data,Variables>extendsOperationRef<Data,Variables>{// (undocumented)refType: typeofMUTATION_STR;}// @publicexportfunctionmutationRef<Data>(dcInstance: DataConnect,mutationName: string): MutationRef<Data,undefined>;// @public (undocumented)exportfunctionmutationRef<Data,Variables>(dcInstance: DataConnect,mutationName: string,variables: Variables): MutationRef<Data,Variables>;// @publicexportinterfaceMutationResult<Data,Variables>extendsDataConnectResult<Data,Variables>{// (undocumented)ref: MutationRef<Data,Variables>;}// @publicexporttypeOnCompleteSubscription=()=>void;// @publicexporttypeOnErrorSubscription=(err?: DataConnectError)=>void;// @publicexporttypeOnResultSubscription<Data,Variables>=(res: QueryResult<Data,Variables>)=>void;// @public (undocumented)exportinterfaceOperationRef<_Data,Variables>{// (undocumented)dataConnect: DataConnect;// (undocumented)name: string;// (undocumented)refType: ReferenceType;// (undocumented)variables: Variables;}// @public (undocumented)exportinterfaceOpResult<Data>{// (undocumented)data: Data;// (undocumented)fetchTime: string;// (undocumented)source: DataSource;}// @public (undocumented)exportconstQUERY_STR="query";// @publicexportinterfaceQueryPromise<Data,Variables>extendsPromise<QueryResult<Data,Variables>>{}// @publicexportinterfaceQueryRef<Data,Variables>extendsOperationRef<Data,Variables>{// (undocumented)refType: typeofQUERY_STR;}// @publicexportfunctionqueryRef<Data>(dcInstance: DataConnect,queryName: string): QueryRef<Data,undefined>;// @publicexportfunctionqueryRef<Data,Variables>(dcInstance: DataConnect,queryName: string,variables: Variables): QueryRef<Data,Variables>;// @publicexportinterfaceQueryResult<Data,Variables>extendsDataConnectResult<Data,Variables>{// (undocumented)ref: QueryRef<Data,Variables>;// (undocumented)toJSON: ()=>SerializedRef<Data,Variables>;}// @publicexporttypeQueryUnsubscribe=()=>void;// @public (undocumented)exporttypeReferenceType=typeofQUERY_STR|typeofMUTATION_STR;// @publicexportinterfaceRefInfo<Variables>{// (undocumented)connectorConfig: DataConnectOptions;// (undocumented)name: string;// (undocumented)variables: Variables;}// @publicexportinterfaceSerializedRef<Data,Variables>extendsOpResult<Data>{// (undocumented)refInfo: RefInfo<Variables>;}// @public (undocumented)exportfunctionsetLogLevel(logLevel: LogLevelString): void;// @public (undocumented)exportconstSOURCE_CACHE="CACHE";// @public (undocumented)exportconstSOURCE_SERVER="SERVER";// @publicexportfunctionsubscribe<Data,Variables>(queryRefOrSerializedResult: QueryRef<Data,Variables>|SerializedRef<Data,Variables>,observer: SubscriptionOptions<Data,Variables>): QueryUnsubscribe;// @publicexportfunctionsubscribe<Data,Variables>(queryRefOrSerializedResult: QueryRef<Data,Variables>|SerializedRef<Data,Variables>,onNext: OnResultSubscription<Data,Variables>,onError?: OnErrorSubscription,onComplete?: OnCompleteSubscription): QueryUnsubscribe;// @publicexportinterfaceSubscriptionOptions<Data,Variables>{// (undocumented)onComplete?: OnCompleteSubscription;// (undocumented)onErr?: OnErrorSubscription;// (undocumented)onNext?: OnResultSubscription<Data,Variables>;}// @publicexportfunctionterminate(dataConnect: DataConnect): Promise<void>;// @publicexportfunctiontoQueryRef<Data,Variables>(serializedRef: SerializedRef<Data,Variables>): QueryRef<Data,Variables>;// @publicexportinterfaceTransportOptions{// (undocumented)host: string;// (undocumented)port?: number;// (undocumented)sslEnabled?: boolean;}
close