firebase-admin
Version:
Firebase admin SDK for Node.js
47 lines (46 loc) • 1.83 kB
TypeScript
/*! firebase-admin v13.7.0 */
/**
* Firebase Data Connect service.
*
* @packageDocumentation
*/
import { App } from '../app';
import { DataConnect } from './data-connect';
import { ConnectorConfig } from './data-connect-api';
export { GraphqlOptions, ExecuteGraphqlResponse, ExecuteOperationResponse, ConnectorConfig, ImpersonateAuthenticated, ImpersonateUnauthenticated, AuthClaims, OperationOptions, } from './data-connect-api';
export { DataConnect, } from './data-connect';
/**
* Gets the {@link DataConnect} service with the provided connector configuration
* for the default app or a given app.
*
* `getDataConnect(connectorConfig)` can be called with no app argument to access the default
* app's `DataConnect` service or as `getDataConnect(connectorConfig, app)` to access the
* `DataConnect` service associated with a specific app.
*
* @example
* ```javascript
* const connectorConfig: ConnectorConfig = {
* location: 'us-west2',
* serviceId: 'my-service',
* connectorName: 'my-connector',
* };
*
* // Get the `DataConnect` service for the default app
* const defaultDataConnect = getDataConnect(connectorConfig);
* ```
*
* @example
* ```javascript
* // Get the `DataConnect` service for a given app
* const otherDataConnect = getDataConnect(connectorConfig, otherApp);
* ```
*
* @param connectorConfig - Connector configuration for the `DataConnect` service.
*
* @param app - Optional app for which to return the `DataConnect` service.
* If not provided, the default `DataConnect` service is returned.
*
* @returns The default `DataConnect` service with the provided connector configuration
* if no app is provided, or the `DataConnect` service associated with the provided app.
*/
export declare function getDataConnect(connectorConfig: ConnectorConfig, app?: App): DataConnect;