Skip to content
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
696 changes: 0 additions & 696 deletions docs-devsite/_toc.yaml

This file was deleted.

51 changes: 51 additions & 0 deletions docs-devsite/data-connect.connectorconfig.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,51 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# ConnectorConfig interface
Connector Config for calling Data Connect backend.

<b>Signature:</b>

```typescript
export declare interface ConnectorConfig
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [connector](./data-connect.connectorconfig.md#connectorconfigconnector) | string | |
| [location](./data-connect.connectorconfig.md#connectorconfiglocation) | string | |
| [service](./data-connect.connectorconfig.md#connectorconfigservice) | string | |

## ConnectorConfig.connector

<b>Signature:</b>

```typescript
connector: string;
```

## ConnectorConfig.location

<b>Signature:</b>

```typescript
location: string;
```

## ConnectorConfig.service

<b>Signature:</b>

```typescript
service: string;
```
116 changes: 116 additions & 0 deletions docs-devsite/data-connect.dataconnect.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,116 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnect class
Class representing Firebase Data Connect

<b>Signature:</b>

```typescript
export declare class DataConnect
```

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(app, dataConnectOptions, \_authProvider, \_appCheckProvider)](./data-connect.dataconnect.md#dataconnectconstructor) | | Constructs a new instance of the <code>DataConnect</code> class |

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [app](./data-connect.dataconnect.md#dataconnectapp) | | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
| [isEmulator](./data-connect.dataconnect.md#dataconnectisemulator) | | boolean | |

## Methods

| Method | Modifiers | Description |
| --- | --- | --- |
| [enableEmulator(transportOptions)](./data-connect.dataconnect.md#dataconnectenableemulator) | | |
| [getSettings()](./data-connect.dataconnect.md#dataconnectgetsettings) | | |
| [setInitialized()](./data-connect.dataconnect.md#dataconnectsetinitialized) | | |

## DataConnect.(constructor)

Constructs a new instance of the `DataConnect` class

<b>Signature:</b>

```typescript
constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
| dataConnectOptions | [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | |
| \_authProvider | Provider&lt;FirebaseAuthInternalName&gt; | |
| \_appCheckProvider | Provider&lt;AppCheckInternalComponentName&gt; | |

## DataConnect.app

<b>Signature:</b>

```typescript
readonly app: FirebaseApp;
```

## DataConnect.isEmulator

<b>Signature:</b>

```typescript
isEmulator: boolean;
```

## DataConnect.enableEmulator()

<b>Signature:</b>

```typescript
enableEmulator(transportOptions: TransportOptions): void;
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| transportOptions | [TransportOptions](./data-connect.transportoptions.md#transportoptions_interface) | |

<b>Returns:</b>

void

## DataConnect.getSettings()

<b>Signature:</b>

```typescript
getSettings(): ConnectorConfig;
```
<b>Returns:</b>

[ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface)

## DataConnect.setInitialized()

<b>Signature:</b>

```typescript
setInitialized(): void;
```
<b>Returns:</b>

void

44 changes: 44 additions & 0 deletions docs-devsite/data-connect.dataconnecterror.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,44 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnectError class
An error returned by a DataConnect operation.

<b>Signature:</b>

```typescript
export declare class DataConnectError extends FirebaseError
```
<b>Extends:</b> [FirebaseError](./util.firebaseerror.md#firebaseerror_class)

## Constructors

| Constructor | Modifiers | Description |
| --- | --- | --- |
| [(constructor)(code, message)](./data-connect.dataconnecterror.md#dataconnecterrorconstructor) | | Constructs a new instance of the <code>DataConnectError</code> class |

## DataConnectError.(constructor)

Constructs a new instance of the `DataConnectError` class

<b>Signature:</b>

```typescript
constructor(code: Code, message: string);
```

#### Parameters

| Parameter | Type | Description |
| --- | --- | --- |
| code | [Code](./data-connect.md#code) | |
| message | string | |

36 changes: 36 additions & 0 deletions docs-devsite/data-connect.dataconnectoperationerror.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,36 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnectOperationError class
An error returned by a DataConnect operation.

<b>Signature:</b>

```typescript
export declare class DataConnectOperationError extends DataConnectError
```
<b>Extends:</b> [DataConnectError](./data-connect.dataconnecterror.md#dataconnecterror_class)

## Properties

| Property | Modifiers | Type | Description |
| --- | --- | --- | --- |
| [response](./data-connect.dataconnectoperationerror.md#dataconnectoperationerrorresponse) | | [DataConnectOperationFailureResponse](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponse_interface) | The response received from the backend. |

## DataConnectOperationError.response

The response received from the backend.

<b>Signature:</b>

```typescript
readonly response: DataConnectOperationFailureResponse;
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnectOperationFailureResponse interface
<b>Signature:</b>

```typescript
export declare interface DataConnectOperationFailureResponse
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [data](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponsedata) | Record&lt;string, unknown&gt; \| null | |
| [errors](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponseerrors) | [DataConnectOperationFailureResponseErrorInfo](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfo_interface)<!-- -->\[\] | |

## DataConnectOperationFailureResponse.data

<b>Signature:</b>

```typescript
readonly data?: Record<string, unknown> | null;
```

## DataConnectOperationFailureResponse.errors

<b>Signature:</b>

```typescript
readonly errors: DataConnectOperationFailureResponseErrorInfo[];
```
Original file line number Diff line number Diff line change
@@ -0,0 +1,40 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnectOperationFailureResponseErrorInfo interface
<b>Signature:</b>

```typescript
export declare interface DataConnectOperationFailureResponseErrorInfo
```

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [message](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfomessage) | string | |
| [path](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfopath) | Array&lt;string \| number&gt; | |

## DataConnectOperationFailureResponseErrorInfo.message

<b>Signature:</b>

```typescript
readonly message: string;
```

## DataConnectOperationFailureResponseErrorInfo.path

<b>Signature:</b>

```typescript
readonly path: Array<string | number>;
```
34 changes: 34 additions & 0 deletions docs-devsite/data-connect.dataconnectoptions.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
Project: /docs/reference/js/_project.yaml
Book: /docs/reference/_book.yaml
page_type: reference

{% comment %}
DO NOT EDIT THIS FILE!
This is generated by the JS SDK team, and any local changes will be
overwritten. Changes should be made in the source code at
https://github.com/firebase/firebase-js-sdk
{% endcomment %}

# DataConnectOptions interface
DataConnectOptions including project id

<b>Signature:</b>

```typescript
export declare interface DataConnectOptions extends ConnectorConfig
```
<b>Extends:</b> [ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface)

## Properties

| Property | Type | Description |
| --- | --- | --- |
| [projectId](./data-connect.dataconnectoptions.md#dataconnectoptionsprojectid) | string | |

## DataConnectOptions.projectId

<b>Signature:</b>

```typescript
projectId: string;
```
Loading
Loading