Skip to content

Commit 0950d9f

Browse files
maneeshtmaneesht
authored
Merge 604295d into 6e0e303 
2 parents 6e0e303 + 604295d commit 0950d9f

25 files changed

+1539
-6
lines changed

‎docs-devsite/_toc.yaml‎

Lines changed: 46 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -398,6 +398,52 @@ toc:
398398
path: /docs/reference/js/auth.userinfo.md
399399
- title: UserMetadata
400400
path: /docs/reference/js/auth.usermetadata.md
401+
- title: data-connect
402+
path: /docs/reference/js/data-connect.md
403+
section:
404+
- title: ConnectorConfig
405+
path: /docs/reference/js/data-connect.connectorconfig.md
406+
- title: DataConnect
407+
path: /docs/reference/js/data-connect.dataconnect.md
408+
- title: DataConnectError
409+
path: /docs/reference/js/data-connect.dataconnecterror.md
410+
- title: DataConnectOperationError
411+
path: /docs/reference/js/data-connect.dataconnectoperationerror.md
412+
- title: DataConnectOperationFailureResponse
413+
path: /docs/reference/js/data-connect.dataconnectoperationfailureresponse.md
414+
- title: DataConnectOperationFailureResponseErrorInfo
415+
path: >-
416+
/docs/reference/js/data-connect.dataconnectoperationfailureresponseerrorinfo.md
417+
- title: DataConnectOptions
418+
path: /docs/reference/js/data-connect.dataconnectoptions.md
419+
- title: DataConnectResult
420+
path: /docs/reference/js/data-connect.dataconnectresult.md
421+
- title: DataConnectSubscription
422+
path: /docs/reference/js/data-connect.dataconnectsubscription.md
423+
- title: MutationPromise
424+
path: /docs/reference/js/data-connect.mutationpromise.md
425+
- title: MutationRef
426+
path: /docs/reference/js/data-connect.mutationref.md
427+
- title: MutationResult
428+
path: /docs/reference/js/data-connect.mutationresult.md
429+
- title: OperationRef
430+
path: /docs/reference/js/data-connect.operationref.md
431+
- title: OpResult
432+
path: /docs/reference/js/data-connect.opresult.md
433+
- title: QueryPromise
434+
path: /docs/reference/js/data-connect.querypromise.md
435+
- title: QueryRef
436+
path: /docs/reference/js/data-connect.queryref.md
437+
- title: QueryResult
438+
path: /docs/reference/js/data-connect.queryresult.md
439+
- title: RefInfo
440+
path: /docs/reference/js/data-connect.refinfo.md
441+
- title: SerializedRef
442+
path: /docs/reference/js/data-connect.serializedref.md
443+
- title: SubscriptionOptions
444+
path: /docs/reference/js/data-connect.subscriptionoptions.md
445+
- title: TransportOptions
446+
path: /docs/reference/js/data-connect.transportoptions.md
401447
- title: database
402448
path: /docs/reference/js/database.md
403449
section:

‎docs-devsite/data-connect.connectorconfig.md‎

Lines changed: 51 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,51 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# ConnectorConfig interface
13+
Connector Config for calling Data Connect backend.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare interface ConnectorConfig
19+
```
20+
21+
## Properties
22+
23+
| Property | Type | Description |
24+
| --- | --- | --- |
25+
| [connector](./data-connect.connectorconfig.md#connectorconfigconnector) | string | |
26+
| [location](./data-connect.connectorconfig.md#connectorconfiglocation) | string | |
27+
| [service](./data-connect.connectorconfig.md#connectorconfigservice) | string | |
28+
29+
## ConnectorConfig.connector
30+
31+
<b>Signature:</b>
32+
33+
```typescript
34+
connector: string;
35+
```
36+
37+
## ConnectorConfig.location
38+
39+
<b>Signature:</b>
40+
41+
```typescript
42+
location: string;
43+
```
44+
45+
## ConnectorConfig.service
46+
47+
<b>Signature:</b>
48+
49+
```typescript
50+
service: string;
51+
```

‎docs-devsite/data-connect.dataconnect.md‎

Lines changed: 116 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,116 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# DataConnect class
13+
Class representing Firebase Data Connect
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class DataConnect
19+
```
20+
21+
## Constructors
22+
23+
| Constructor | Modifiers | Description |
24+
| --- | --- | --- |
25+
| [(constructor)(app, dataConnectOptions, \_authProvider, \_appCheckProvider)](./data-connect.dataconnect.md#dataconnectconstructor) | | Constructs a new instance of the <code>DataConnect</code> class |
26+
27+
## Properties
28+
29+
| Property | Modifiers | Type | Description |
30+
| --- | --- | --- | --- |
31+
| [app](./data-connect.dataconnect.md#dataconnectapp) | | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
32+
| [isEmulator](./data-connect.dataconnect.md#dataconnectisemulator) | | boolean | |
33+
34+
## Methods
35+
36+
| Method | Modifiers | Description |
37+
| --- | --- | --- |
38+
| [enableEmulator(transportOptions)](./data-connect.dataconnect.md#dataconnectenableemulator) | | |
39+
| [getSettings()](./data-connect.dataconnect.md#dataconnectgetsettings) | | |
40+
| [setInitialized()](./data-connect.dataconnect.md#dataconnectsetinitialized) | | |
41+
42+
## DataConnect.(constructor)
43+
44+
Constructs a new instance of the `DataConnect` class
45+
46+
<b>Signature:</b>
47+
48+
```typescript
49+
constructor(app: FirebaseApp, dataConnectOptions: DataConnectOptions, _authProvider: Provider<FirebaseAuthInternalName>, _appCheckProvider: Provider<AppCheckInternalComponentName>);
50+
```
51+
52+
#### Parameters
53+
54+
| Parameter | Type | Description |
55+
| --- | --- | --- |
56+
| app | [FirebaseApp](./app.firebaseapp.md#firebaseapp_interface) | |
57+
| dataConnectOptions | [DataConnectOptions](./data-connect.dataconnectoptions.md#dataconnectoptions_interface) | |
58+
| \_authProvider | Provider&lt;FirebaseAuthInternalName&gt; | |
59+
| \_appCheckProvider | Provider&lt;AppCheckInternalComponentName&gt; | |
60+
61+
## DataConnect.app
62+
63+
<b>Signature:</b>
64+
65+
```typescript
66+
readonly app: FirebaseApp;
67+
```
68+
69+
## DataConnect.isEmulator
70+
71+
<b>Signature:</b>
72+
73+
```typescript
74+
isEmulator: boolean;
75+
```
76+
77+
## DataConnect.enableEmulator()
78+
79+
<b>Signature:</b>
80+
81+
```typescript
82+
enableEmulator(transportOptions: TransportOptions): void;
83+
```
84+
85+
#### Parameters
86+
87+
| Parameter | Type | Description |
88+
| --- | --- | --- |
89+
| transportOptions | [TransportOptions](./data-connect.transportoptions.md#transportoptions_interface) | |
90+
91+
<b>Returns:</b>
92+
93+
void
94+
95+
## DataConnect.getSettings()
96+
97+
<b>Signature:</b>
98+
99+
```typescript
100+
getSettings(): ConnectorConfig;
101+
```
102+
<b>Returns:</b>
103+
104+
[ConnectorConfig](./data-connect.connectorconfig.md#connectorconfig_interface)
105+
106+
## DataConnect.setInitialized()
107+
108+
<b>Signature:</b>
109+
110+
```typescript
111+
setInitialized(): void;
112+
```
113+
<b>Returns:</b>
114+
115+
void
116+

‎docs-devsite/data-connect.dataconnecterror.md‎

Lines changed: 44 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,44 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# DataConnectError class
13+
An error returned by a DataConnect operation.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class DataConnectError extends FirebaseError
19+
```
20+
<b>Extends:</b> [FirebaseError](./util.firebaseerror.md#firebaseerror_class)
21+
22+
## Constructors
23+
24+
| Constructor | Modifiers | Description |
25+
| --- | --- | --- |
26+
| [(constructor)(code, message)](./data-connect.dataconnecterror.md#dataconnecterrorconstructor) | | Constructs a new instance of the <code>DataConnectError</code> class |
27+
28+
## DataConnectError.(constructor)
29+
30+
Constructs a new instance of the `DataConnectError` class
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
constructor(code: Code, message: string);
36+
```
37+
38+
#### Parameters
39+
40+
| Parameter | Type | Description |
41+
| --- | --- | --- |
42+
| code | [Code](./data-connect.md#code) | |
43+
| message | string | |
44+

‎docs-devsite/data-connect.dataconnectoperationerror.md‎

Lines changed: 36 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,36 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# DataConnectOperationError class
13+
An error returned by a DataConnect operation.
14+
15+
<b>Signature:</b>
16+
17+
```typescript
18+
export declare class DataConnectOperationError extends DataConnectError
19+
```
20+
<b>Extends:</b> [DataConnectError](./data-connect.dataconnecterror.md#dataconnecterror_class)
21+
22+
## Properties
23+
24+
| Property | Modifiers | Type | Description |
25+
| --- | --- | --- | --- |
26+
| [response](./data-connect.dataconnectoperationerror.md#dataconnectoperationerrorresponse) | | [DataConnectOperationFailureResponse](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponse_interface) | The response received from the backend. |
27+
28+
## DataConnectOperationError.response
29+
30+
The response received from the backend.
31+
32+
<b>Signature:</b>
33+
34+
```typescript
35+
readonly response: DataConnectOperationFailureResponse;
36+
```

‎docs-devsite/data-connect.dataconnectoperationfailureresponse.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# DataConnectOperationFailureResponse interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export declare interface DataConnectOperationFailureResponse
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [data](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponsedata) | Record&lt;string, unknown&gt; \| null | |
24+
| [errors](./data-connect.dataconnectoperationfailureresponse.md#dataconnectoperationfailureresponseerrors) | [DataConnectOperationFailureResponseErrorInfo](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfo_interface)<!-- -->\[\] | |
25+
26+
## DataConnectOperationFailureResponse.data
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
readonly data?: Record<string, unknown> | null;
32+
```
33+
34+
## DataConnectOperationFailureResponse.errors
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
readonly errors: DataConnectOperationFailureResponseErrorInfo[];
40+
```

‎docs-devsite/data-connect.dataconnectoperationfailureresponseerrorinfo.md‎

Lines changed: 40 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,40 @@
1+
Project: /docs/reference/js/_project.yaml
2+
Book: /docs/reference/_book.yaml
3+
page_type: reference
4+
5+
{% comment %}
6+
DO NOT EDIT THIS FILE!
7+
This is generated by the JS SDK team, and any local changes will be
8+
overwritten. Changes should be made in the source code at
9+
https://github.com/firebase/firebase-js-sdk
10+
{% endcomment %}
11+
12+
# DataConnectOperationFailureResponseErrorInfo interface
13+
<b>Signature:</b>
14+
15+
```typescript
16+
export declare interface DataConnectOperationFailureResponseErrorInfo
17+
```
18+
19+
## Properties
20+
21+
| Property | Type | Description |
22+
| --- | --- | --- |
23+
| [message](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfomessage) | string | |
24+
| [path](./data-connect.dataconnectoperationfailureresponseerrorinfo.md#dataconnectoperationfailureresponseerrorinfopath) | Array&lt;string \| number&gt; | |
25+
26+
## DataConnectOperationFailureResponseErrorInfo.message
27+
28+
<b>Signature:</b>
29+
30+
```typescript
31+
readonly message: string;
32+
```
33+
34+
## DataConnectOperationFailureResponseErrorInfo.path
35+
36+
<b>Signature:</b>
37+
38+
```typescript
39+
readonly path: Array<string | number>;
40+
```

0 commit comments

Comments
 (0)