@firebase/data-connect 0.0.2-dataconnect-preview.877f8b7d0 → 0.0.2-dataconnect-preview.388b61c7e

package/dist/node-esm/src/api/query.d.ts

@@ -17,28 +17,78 @@
 import { DataConnectError } from '../core/error';
 import { DataConnect } from './DataConnect';
 import { OperationRef, QUERY_STR, DataConnectResult, SerializedRef } from './Reference';
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
 export declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
 export declare type OnErrorSubscription = (err?: DataConnectError) => void;
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
 export declare type QueryUnsubscribe = () => void;
+/**
+ * Representation of user provided subscription options.
+ */
 export interface DataConnectSubscription<Data, Variables> {
     userCallback: OnResultSubscription<Data, Variables>;
     errCallback?: (e?: DataConnectError) => void;
     unsubscribe: () => void;
 }
+/**
+ * QueryRef object
+ */
 export interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
+/**
+ * Result of `executeQuery`
+ */
 export interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: QueryRef<Data, Variables>;
     toJSON: () => SerializedRef<Data, Variables>;
 }
+/**
+ * Promise returned from `executeQuery`
+ */
 export interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
 }
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @param variables Variables to execute with
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
 export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
+/**
+ * `OnCompleteSubscription`
+ */
 export declare type OnCompleteSubscription = () => void;
+/**
+ * Representation of full observer options in `subscribe`
+ */
 export interface SubscriptionOptions<Data, Variables> {
     onNext?: OnResultSubscription<Data, Variables>;
     onErr?: OnErrorSubscription;

package/dist/node-esm/src/api.browser.d.ts

@@ -17,13 +17,18 @@
 import { OnCompleteSubscription, OnErrorSubscription, OnResultSubscription, QueryRef, QueryUnsubscribe, SubscriptionOptions } from './api/query';
 import { SerializedRef } from './api/Reference';
 /**
- *
- * @public
- * @param queryRef
- * @param onResult
- * @param onErr
- * @param initialCache
- * @returns
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param observer observer object to use for subscribing.
+ * @returns `SubscriptionOptions`
  */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param onNext Callback to call when result comes back.
+ * @param onError Callback to call when error gets thrown.
+ * @param onComplete Called when subscription completes.
+ * @returns `SubscriptionOptions`
+ */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;

package/dist/private.d.ts

@@ -25,14 +25,27 @@ export declare interface CancellableOperation<T> extends PromiseLike<{
     cancel: () => void;
 }
 
+/**
+ * Connect to the DataConnect Emulator
+ * @param dc Data Connect instance
+ * @param host host of emulator server
+ * @param port port of emulator server
+ * @param sslEnabled use https
+ */
 export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
 
+/**
+ * Connector Config for calling Data Connect backend.
+ */
 export declare interface ConnectorConfig {
     location: string;
     connector: string;
     service: string;
 }
 
+/**
+ * Class representing Firebase Data Connect
+ */
 export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
@@ -78,6 +91,9 @@ declare class DataConnectError extends FirebaseError {
 
 declare type DataConnectErrorCode = 'other' | 'already-initialized' | 'not-initialized' | 'not-supported' | 'invalid-argument' | 'partial-error';
 
+/**
+ * DataConnectOptions including project id
+ */
 export declare interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
@@ -86,6 +102,9 @@ export declare interface DataConnectResult<Data, Variables> extends OpResult<Dat
     ref: OperationRef<Data, Variables>;
 }
 
+/**
+ * Representation of user provided subscription options.
+ */
 export declare interface DataConnectSubscription<Data, Variables> {
     userCallback: OnResultSubscription<Data, Variables>;
     errCallback?: (e?: DataConnectError) => void;
@@ -107,8 +126,18 @@ export declare interface DataConnectTransport {
 
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
 
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
 
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
 
 export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
@@ -124,19 +153,26 @@ export declare class FirebaseAuthProvider implements AuthTokenProvider {
     removeTokenChangeListener(listener: (token: string | null) => void): void;
 }
 
+/**
+ * Initialize DataConnect instance
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(options: ConnectorConfig): DataConnect;
 
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
 
 export declare const MUTATION_STR = "mutation";
 
-export declare class MutationManager {
-    private _transport;
-    private _inflight;
-    constructor(_transport: DataConnectTransport);
-    executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
-}
+/* Excluded from this release type: MutationManager */
 
+/**
+ * Mutation return value from `executeMutation`
+ */
 export declare interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
 }
 
@@ -144,21 +180,44 @@ export declare interface MutationRef<Data, Variables> extends OperationRef<Data,
     refType: typeof MUTATION_STR;
 }
 
-export declare function mutationRef<Data>(dcInstance: DataConnect, queryName: string): MutationRef<Data, undefined>;
+/**
+ * Creates a `MutationRef`
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ */
+export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName: string): MutationRef<Data, undefined>;
 
+/**
+ *
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ * @param variables variables to send with mutation
+ */
 export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
 
 export declare interface MutationResponse<T> extends CancellableOperation<T> {
 }
 
+/**
+ * Mutation Result from `executeMutation`
+ */
 export declare interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: MutationRef<Data, Variables>;
 }
 
+/**
+ * `OnCompleteSubscription`
+ */
 export declare type OnCompleteSubscription = () => void;
 
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
 export declare type OnErrorSubscription = (err?: DataConnectError) => void;
 
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
 export declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
 
 export declare interface OperationRef<_Data, Variables> {
@@ -188,29 +247,57 @@ declare class QueryManager {
     enableEmulator(host: string, port: number): void;
 }
 
+/**
+ * Promise returned from `executeQuery`
+ */
 export declare interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
 }
 
+/**
+ * QueryRef object
+ */
 export declare interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
 
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
 
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @param variables Variables to execute with
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
 
 export declare interface QueryResponse<T> extends CancellableOperation<T> {
 }
 
+/**
+ * Result of `executeQuery`
+ */
 export declare interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: QueryRef<Data, Variables>;
     toJSON: () => SerializedRef<Data, Variables>;
 }
 
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
 export declare type QueryUnsubscribe = () => void;
 
 export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
 
+/**
+ * Serialized RefInfo as a result of `QueryResult.toJSON().refInfo`
+ */
 export declare interface RefInfo<Variables> {
     name: string;
     variables: Variables;
@@ -222,6 +309,9 @@ export declare interface Sender<T> {
     send: () => Promise<T>;
 }
 
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
 export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }
@@ -233,26 +323,44 @@ export declare const SOURCE_CACHE = "CACHE";
 export declare const SOURCE_SERVER = "SERVER";
 
 /**
- *
- * @public
- * @param queryRef
- * @param onResult
- * @param onErr
- * @param initialCache
- * @returns
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param observer observer object to use for subscribing.
+ * @returns `SubscriptionOptions`
  */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
 
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param onNext Callback to call when result comes back.
+ * @param onError Callback to call when error gets thrown.
+ * @param onComplete Called when subscription completes.
+ * @returns `SubscriptionOptions`
+ */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;
 
+/**
+ * Representation of full observer options in `subscribe`
+ */
 export declare interface SubscriptionOptions<Data, Variables> {
     onNext?: OnResultSubscription<Data, Variables>;
     onErr?: OnErrorSubscription;
     onComplete?: OnCompleteSubscription;
 }
 
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 export declare function terminate(dataConnect: DataConnect): Promise<void>;
 
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
 export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
 
 declare interface TrackedQuery<Data, Variables> {
@@ -264,6 +372,9 @@ declare interface TrackedQuery<Data, Variables> {
 
 export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
 
+/**
+ * Options to connect to emulator
+ */
 export declare interface TransportOptions {
     host: string;
     sslEnabled?: boolean;

package/dist/public.d.ts

@@ -21,12 +21,25 @@ export declare interface CancellableOperation<T> extends PromiseLike<{
 }> {
     cancel: () => void;
 }
+/**
+ * Connect to the DataConnect Emulator
+ * @param dc Data Connect instance
+ * @param host host of emulator server
+ * @param port port of emulator server
+ * @param sslEnabled use https
+ */
 export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
+/**
+ * Connector Config for calling Data Connect backend.
+ */
 export declare interface ConnectorConfig {
     location: string;
     connector: string;
     service: string;
 }
+/**
+ * Class representing Firebase Data Connect
+ */
 export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
@@ -37,12 +50,18 @@ export declare class DataConnect {
     setInitialized(): void;
     enableEmulator(transportOptions: TransportOptions): void;
 }
+/**
+ * DataConnectOptions including project id
+ */
 export declare interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
 export declare interface DataConnectResult<Data, Variables> extends OpResult<Data> {
     ref: OperationRef<Data, Variables>;
 }
+/**
+ * Representation of user provided subscription options.
+ */
 export declare interface DataConnectSubscription<Data, Variables> {
     userCallback: OnResultSubscription<Data, Variables>;
     errCallback?: (e?: FirebaseError) => void;
@@ -61,7 +80,17 @@ export declare interface DataConnectTransport {
     onTokenChanged: (token: string | null) => void;
 }
 export declare type DataSource = typeof SOURCE_CACHE | typeof SOURCE_SERVER;
+/**
+ * Execute Mutation
+ * @param mutationRef mutation to execute
+ * @returns `MutationRef`
+ */
 export declare function executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
+/**
+ * Execute Query
+ * @param queryRef query to execute.
+ * @returns `QueryPromise`
+ */
 export declare function executeQuery<Data, Variables>(queryRef: QueryRef<Data, Variables>): QueryPromise<Data, Variables>;
 export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CONNECT_EMULATOR_HOST";
 export declare class FirebaseAuthProvider implements AuthTokenProvider {
@@ -70,27 +99,59 @@ export declare class FirebaseAuthProvider implements AuthTokenProvider {
     addTokenChangeListener(listener: AuthTokenListener): void;
     removeTokenChangeListener(listener: (token: string | null) => void): void;
 }
+/**
+ * Initialize DataConnect instance
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(options: ConnectorConfig): DataConnect;
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
 export declare const MUTATION_STR = "mutation";
-export declare class MutationManager {
-    constructor(_transport: DataConnectTransport);
-    executeMutation<Data, Variables>(mutationRef: MutationRef<Data, Variables>): MutationPromise<Data, Variables>;
-}
+/* Excluded from this release type: MutationManager */
+/**
+ * Mutation return value from `executeMutation`
+ */
 export declare interface MutationPromise<Data, Variables> extends PromiseLike<MutationResult<Data, Variables>> {
 }
 export declare interface MutationRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof MUTATION_STR;
 }
-export declare function mutationRef<Data>(dcInstance: DataConnect, queryName: string): MutationRef<Data, undefined>;
+/**
+ * Creates a `MutationRef`
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ */
+export declare function mutationRef<Data>(dcInstance: DataConnect, mutationName: string): MutationRef<Data, undefined>;
+/**
+ *
+ * @param dcInstance Data Connect instance
+ * @param mutationName name of mutation
+ * @param variables variables to send with mutation
+ */
 export declare function mutationRef<Data, Variables>(dcInstance: DataConnect, mutationName: string, variables: Variables): MutationRef<Data, Variables>;
 export declare interface MutationResponse<T> extends CancellableOperation<T> {
 }
+/**
+ * Mutation Result from `executeMutation`
+ */
 export declare interface MutationResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: MutationRef<Data, Variables>;
 }
+/**
+ * `OnCompleteSubscription`
+ */
 export declare type OnCompleteSubscription = () => void;
+/**
+ * Signature for `OnErrorSubscription` for `subscribe`
+ */
 export declare type OnErrorSubscription = (err?: FirebaseError) => void;
+/**
+ * Signature for `OnResultSubscription` for `subscribe`
+ */
 export declare type OnResultSubscription<Data, Variables> = (res: QueryResult<Data, Variables>) => void;
 export declare interface OperationRef<_Data, Variables> {
     name: string;
@@ -105,21 +166,49 @@ export declare interface OpResult<Data> {
 }
 /* Excluded from this release type: parseOptions */
 export declare const QUERY_STR = "query";
+/**
+ * Promise returned from `executeQuery`
+ */
 export declare interface QueryPromise<Data, Variables> extends PromiseLike<QueryResult<Data, Variables>> {
 }
+/**
+ * QueryRef object
+ */
 export declare interface QueryRef<Data, Variables> extends OperationRef<Data, Variables> {
     refType: typeof QUERY_STR;
 }
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data>(dcInstance: DataConnect, queryName: string): QueryRef<Data, undefined>;
+/**
+ * Execute Query
+ * @param dcInstance Data Connect instance to use.
+ * @param queryName Query to execute
+ * @param variables Variables to execute with
+ * @returns `QueryRef`
+ */
 export declare function queryRef<Data, Variables>(dcInstance: DataConnect, queryName: string, variables: Variables): QueryRef<Data, Variables>;
 export declare interface QueryResponse<T> extends CancellableOperation<T> {
 }
+/**
+ * Result of `executeQuery`
+ */
 export declare interface QueryResult<Data, Variables> extends DataConnectResult<Data, Variables> {
     ref: QueryRef<Data, Variables>;
     toJSON: () => SerializedRef<Data, Variables>;
 }
+/**
+ * Signature for unsubscribe from `subscribe`
+ */
 export declare type QueryUnsubscribe = () => void;
 export declare type ReferenceType = typeof QUERY_STR | typeof MUTATION_STR;
+/**
+ * Serialized RefInfo as a result of `QueryResult.toJSON().refInfo`
+ */
 export declare interface RefInfo<Variables> {
     name: string;
     variables: Variables;
@@ -129,6 +218,9 @@ export declare interface Sender<T> {
     abort: () => void;
     send: () => Promise<T>;
 }
+/**
+ * Serialized Ref as a result of `QueryResult.toJSON()`
+ */
 export declare interface SerializedRef<Data, Variables> extends OpResult<Data> {
     refInfo: RefInfo<Variables>;
 }
@@ -136,24 +228,45 @@ export declare function setLogLevel(logLevel: LogLevelString): void;
 export declare const SOURCE_CACHE = "CACHE";
 export declare const SOURCE_SERVER = "SERVER";
 /**
- *
- * @public
- * @param queryRef
- * @param onResult
- * @param onErr
- * @param initialCache
- * @returns
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param observer observer object to use for subscribing.
+ * @returns `SubscriptionOptions`
  */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, observer: SubscriptionOptions<Data, Variables>): QueryUnsubscribe;
+/**
+ * Subscribe to a `QueryRef`
+ * @param queryRefOrSerializedResult query ref or serialized result.
+ * @param onNext Callback to call when result comes back.
+ * @param onError Callback to call when error gets thrown.
+ * @param onComplete Called when subscription completes.
+ * @returns `SubscriptionOptions`
+ */
 export declare function subscribe<Data, Variables>(queryRefOrSerializedResult: QueryRef<Data, Variables> | SerializedRef<Data, Variables>, onNext: OnResultSubscription<Data, Variables>, onError?: OnErrorSubscription, onComplete?: OnCompleteSubscription): QueryUnsubscribe;
+/**
+ * Representation of full observer options in `subscribe`
+ */
 export declare interface SubscriptionOptions<Data, Variables> {
     onNext?: OnResultSubscription<Data, Variables>;
     onErr?: OnErrorSubscription;
     onComplete?: OnCompleteSubscription;
 }
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 export declare function terminate(dataConnect: DataConnect): Promise<void>;
+/**
+ * Converts serialized ref to query ref
+ * @param serializedRef ref to convert to `QueryRef`
+ * @returns `QueryRef`
+ */
 export declare function toQueryRef<Data, Variables>(serializedRef: SerializedRef<Data, Variables>): QueryRef<unknown, Variables>;
 export declare type TransportClass = new (options: DataConnectOptions, apiKey?: string, authProvider?: AuthTokenProvider, transportOptions?: TransportOptions) => DataConnectTransport;
+/**
+ * Options to connect to emulator
+ */
 export declare interface TransportOptions {
     host: string;
     sslEnabled?: boolean;

package/dist/src/api/DataConnect.d.ts

@@ -19,11 +19,17 @@ import { FirebaseAuthInternalName } from '@firebase/auth-interop-types';
 import { Provider } from '@firebase/component';
 import { QueryManager } from '../core/QueryManager';
 import { MutationManager } from './Mutation';
+/**
+ * Connector Config for calling Data Connect backend.
+ */
 export interface ConnectorConfig {
     location: string;
     connector: string;
     service: string;
 }
+/**
+ * Options to connect to emulator
+ */
 export interface TransportOptions {
     host: string;
     sslEnabled?: boolean;
@@ -37,9 +43,15 @@ export declare const FIREBASE_DATA_CONNECT_EMULATOR_HOST_VAR = "FIREBASE_DATA_CO
  * @internal
  */
 export declare function parseOptions(fullHost: string): TransportOptions;
+/**
+ * DataConnectOptions including project id
+ */
 export interface DataConnectOptions extends ConnectorConfig {
     projectId: string;
 }
+/**
+ * Class representing Firebase Data Connect
+ */
 export declare class DataConnect {
     readonly app: FirebaseApp;
     private readonly dataConnectOptions;
@@ -58,7 +70,28 @@ export declare class DataConnect {
     setInitialized(): void;
     enableEmulator(transportOptions: TransportOptions): void;
 }
+/**
+ * Connect to the DataConnect Emulator
+ * @param dc Data Connect instance
+ * @param host host of emulator server
+ * @param port port of emulator server
+ * @param sslEnabled use https
+ */
 export declare function connectDataConnectEmulator(dc: DataConnect, host: string, port?: number, sslEnabled?: boolean): void;
+/**
+ * Initialize DataConnect instance
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(options: ConnectorConfig): DataConnect;
+/**
+ * Initialize DataConnect instance
+ * @param app FirebaseApp to initialize to.
+ * @param options ConnectorConfig
+ */
 export declare function getDataConnect(app: FirebaseApp, options: ConnectorConfig): DataConnect;
+/**
+ * Delete DataConnect instance
+ * @param dataConnect DataConnect instance
+ * @returns
+ */
 export declare function terminate(dataConnect: DataConnect): Promise<void>;