Skip to content

Commit

Permalink
Updating typedocs for rc.1
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesdaniels committed Feb 11, 2019
1 parent f48608e commit d9ca37c
Show file tree
Hide file tree
Showing 14 changed files with 87 additions and 87 deletions.
42 changes: 21 additions & 21 deletions docs/reference/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -53,8 +53,8 @@

**Ƭ BoundOp**: *`string` \| `number` \| `boolean` \| `null` \| [`string` \| `number` \| `boolean` \| `null`, `string`]*

*Defined in [adapters/firestore.ts:205](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L205)*
*Defined in [adapters/realtime-database.ts:168](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L168)*
*Defined in [adapters/firestore.ts:205](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L205)*
*Defined in [adapters/realtime-database.ts:168](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L168)*

___
<a id="collectionreferenceorquery"></a>
Expand All @@ -63,7 +63,7 @@ ___

**Ƭ CollectionReferenceOrQuery**: *`CollectionReference` \| `Query`*

*Defined in [adapters/firestore.ts:199](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L199)*
*Defined in [adapters/firestore.ts:199](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L199)*

___
<a id="documentsnapshot"></a>
Expand All @@ -72,7 +72,7 @@ ___

**Ƭ DocumentSnapshot**: *`DocumentSnapshot` \| `QueryDocumentSnapshot`*

*Defined in [serializers/firestore.ts:4](https://github.com/firebase/emberfire/blob/v3/addon/serializers/firestore.ts#L4)*
*Defined in [serializers/firestore.ts:4](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/serializers/firestore.ts#L4)*

___
<a id="orderop"></a>
Expand All @@ -81,7 +81,7 @@ ___

**Ƭ OrderOp**: *`string` \| `object`*

*Defined in [adapters/firestore.ts:204](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L204)*
*Defined in [adapters/firestore.ts:204](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L204)*

___
<a id="queryfn"></a>
Expand All @@ -90,8 +90,8 @@ ___

**Ƭ QueryFn**: *`function`*

*Defined in [adapters/firestore.ts:200](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L200)*
*Defined in [adapters/realtime-database.ts:163](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L163)*
*Defined in [adapters/firestore.ts:200](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L200)*
*Defined in [adapters/realtime-database.ts:163](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L163)*

#### Type declaration
▸(ref: *`Reference`*): [ReferenceOrQuery](#referenceorquery)
Expand All @@ -111,8 +111,8 @@ ___

**Ƭ QueryOptions**: *`object` \| `object` & `object`*

*Defined in [adapters/firestore.ts:212](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L212)*
*Defined in [adapters/realtime-database.ts:175](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L175)*
*Defined in [adapters/firestore.ts:212](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L212)*
*Defined in [adapters/realtime-database.ts:175](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L175)*

___
<a id="queryoptionsonlyquery"></a>
Expand All @@ -121,8 +121,8 @@ ___

**Ƭ QueryOptionsOnlyQuery**: *`object`*

*Defined in [adapters/firestore.ts:207](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L207)*
*Defined in [adapters/realtime-database.ts:170](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L170)*
*Defined in [adapters/firestore.ts:207](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L207)*
*Defined in [adapters/realtime-database.ts:170](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L170)*

#### Type declaration

Expand All @@ -133,7 +133,7 @@ ___

**Ƭ QueryRecordFn**: *`function`*

*Defined in [adapters/firestore.ts:201](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L201)*
*Defined in [adapters/firestore.ts:201](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L201)*

#### Type declaration
▸(ref: *`CollectionReference`*): `DocumentReference`
Expand All @@ -153,7 +153,7 @@ ___

**Ƭ QueryRecordOptions**: *`object`*

*Defined in [adapters/firestore.ts:223](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L223)*
*Defined in [adapters/firestore.ts:223](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L223)*

#### Type declaration

Expand All @@ -164,7 +164,7 @@ ___

**Ƭ ReferenceOrQuery**: *`Reference` \| `Query`*

*Defined in [adapters/realtime-database.ts:161](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L161)*
*Defined in [adapters/realtime-database.ts:161](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L161)*

___
<a id="referenceorqueryfn"></a>
Expand All @@ -173,7 +173,7 @@ ___

**Ƭ ReferenceOrQueryFn**: *`function`*

*Defined in [adapters/realtime-database.ts:162](https://github.com/firebase/emberfire/blob/v3/addon/adapters/realtime-database.ts#L162)*
*Defined in [adapters/realtime-database.ts:162](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/realtime-database.ts#L162)*

#### Type declaration
▸(ref: *[ReferenceOrQuery](#referenceorquery)*): [ReferenceOrQuery](#referenceorquery)
Expand All @@ -193,7 +193,7 @@ ___

**Ƭ Snapshot**: *`DocumentSnapshot` \| `QuerySnapshot`*

*Defined in [serializers/firestore.ts:5](https://github.com/firebase/emberfire/blob/v3/addon/serializers/firestore.ts#L5)*
*Defined in [serializers/firestore.ts:5](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/serializers/firestore.ts#L5)*

___
<a id="whereop"></a>
Expand All @@ -202,7 +202,7 @@ ___

**Ƭ WhereOp**: *[`string` \| `FieldPath`, `firestore.WhereFilterOp`, `any`]*

*Defined in [adapters/firestore.ts:203](https://github.com/firebase/emberfire/blob/v3/addon/adapters/firestore.ts#L203)*
*Defined in [adapters/firestore.ts:203](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/adapters/firestore.ts#L203)*

___

Expand All @@ -216,7 +216,7 @@ ___

**normalize**(store: *`Store`*, modelClass: *`Model`*, snapshot: *`DataSnapshot`*): `object`

*Defined in [serializers/firestore.ts:32](https://github.com/firebase/emberfire/blob/v3/addon/serializers/firestore.ts#L32)*
*Defined in [serializers/firestore.ts:32](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/serializers/firestore.ts#L32)*

**Parameters:**

Expand All @@ -228,7 +228,7 @@ ___

**Returns:** `object`

*Defined in [serializers/realtime-database.ts:31](https://github.com/firebase/emberfire/blob/v3/addon/serializers/realtime-database.ts#L31)*
*Defined in [serializers/realtime-database.ts:31](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/serializers/realtime-database.ts#L31)*

**Parameters:**

Expand All @@ -247,7 +247,7 @@ ___

**subscribe**(route: *`Object`*, model: *`Model`*): `false` \| `void`

*Defined in [services/realtime-listener.ts:18](https://github.com/firebase/emberfire/blob/v3/addon/services/realtime-listener.ts#L18)*
*Defined in [services/realtime-listener.ts:18](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/realtime-listener.ts#L18)*

**Parameters:**

Expand All @@ -265,7 +265,7 @@ ___

**unsubscribe**(route: *`Object`*): `false` \| `void`

*Defined in [services/realtime-listener.ts:19](https://github.com/firebase/emberfire/blob/v3/addon/services/realtime-listener.ts#L19)*
*Defined in [services/realtime-listener.ts:19](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/realtime-listener.ts#L19)*

**Parameters:**

Expand Down
22 changes: 11 additions & 11 deletions docs/reference/classes/firebaseappservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@

**● firebase**: *`ComputedProperty`<[FirebaseService](firebaseservice.md), [FirebaseService](firebaseservice.md)>*

*Defined in [services/firebase-app.ts:35](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L35)*
*Defined in [services/firebase-app.ts:35](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L35)*

___
<a id="name"></a>
Expand All @@ -46,7 +46,7 @@ ___

**● name**: *`undefined` \| `string`*

*Defined in [services/firebase-app.ts:35](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L35)*
*Defined in [services/firebase-app.ts:35](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L35)*

___
<a id="options"></a>
Expand All @@ -55,7 +55,7 @@ ___

**● options**: *`undefined` \| `object`*

*Defined in [services/firebase-app.ts:37](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L37)*
*Defined in [services/firebase-app.ts:37](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L37)*

___

Expand All @@ -67,7 +67,7 @@ ___

**auth**(): `Promise`<`Auth`>

*Defined in [services/firebase-app.ts:40](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L40)*
*Defined in [services/firebase-app.ts:40](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L40)*

**Returns:** `Promise`<`Auth`>

Expand All @@ -78,7 +78,7 @@ ___

**database**(databaseURL?: *`undefined` \| `string`*): `Promise`<`Database`>

*Defined in [services/firebase-app.ts:41](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L41)*
*Defined in [services/firebase-app.ts:41](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L41)*

**Parameters:**

Expand All @@ -95,7 +95,7 @@ ___

**delete**(): `Promise`<`any`>

*Defined in [services/firebase-app.ts:39](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L39)*
*Defined in [services/firebase-app.ts:39](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L39)*

**Returns:** `Promise`<`any`>

Expand All @@ -106,7 +106,7 @@ ___

**firestore**(): `Promise`<`Firestore`>

*Defined in [services/firebase-app.ts:42](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L42)*
*Defined in [services/firebase-app.ts:42](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L42)*

**Returns:** `Promise`<`Firestore`>

Expand All @@ -117,7 +117,7 @@ ___

**functions**(region?: *`undefined` \| `string`*): `Promise`<`Functions`>

*Defined in [services/firebase-app.ts:43](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L43)*
*Defined in [services/firebase-app.ts:43](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L43)*

**Parameters:**

Expand All @@ -134,7 +134,7 @@ ___

**init**(): `void`

*Defined in [services/firebase-app.ts:47](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L47)*
*Defined in [services/firebase-app.ts:47](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L47)*

**Returns:** `void`

Expand All @@ -145,7 +145,7 @@ ___

**messaging**(): `Promise`<`Messaging`>

*Defined in [services/firebase-app.ts:44](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L44)*
*Defined in [services/firebase-app.ts:44](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L44)*

**Returns:** `Promise`<`Messaging`>

Expand All @@ -156,7 +156,7 @@ ___

**storage**(storageBucket?: *`undefined` \| `string`*): `Promise`<`Storage`>

*Defined in [services/firebase-app.ts:45](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase-app.ts#L45)*
*Defined in [services/firebase-app.ts:45](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase-app.ts#L45)*

**Parameters:**

Expand Down
8 changes: 4 additions & 4 deletions docs/reference/classes/firebaseauthenticator.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@

**● firebaseApp**: *`ComputedProperty`<[FirebaseAppService](firebaseappservice.md), [FirebaseAppService](firebaseappservice.md)>*

*Defined in [authenticators/firebase.ts:18](https://github.com/firebase/emberfire/blob/v3/addon/authenticators/firebase.ts#L18)*
*Defined in [authenticators/firebase.ts:18](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/authenticators/firebase.ts#L18)*

___

Expand All @@ -42,7 +42,7 @@ ___

**authenticate**(): `Promise`<`never`>

*Defined in [authenticators/firebase.ts:24](https://github.com/firebase/emberfire/blob/v3/addon/authenticators/firebase.ts#L24)*
*Defined in [authenticators/firebase.ts:24](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/authenticators/firebase.ts#L24)*

**Returns:** `Promise`<`never`>

Expand All @@ -53,7 +53,7 @@ ___

**invalidate**(): `Promise`<`void`>

*Defined in [authenticators/firebase.ts:28](https://github.com/firebase/emberfire/blob/v3/addon/authenticators/firebase.ts#L28)*
*Defined in [authenticators/firebase.ts:28](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/authenticators/firebase.ts#L28)*

**Returns:** `Promise`<`void`>

Expand All @@ -64,7 +64,7 @@ ___

**restore**(data: *`any`*): `Promise`<`any`>

*Defined in [authenticators/firebase.ts:20](https://github.com/firebase/emberfire/blob/v3/addon/authenticators/firebase.ts#L20)*
*Defined in [authenticators/firebase.ts:20](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/authenticators/firebase.ts#L20)*

**Parameters:**

Expand Down
6 changes: 3 additions & 3 deletions docs/reference/classes/firebaseservice.md
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@

**● apps**: *`App`[]* = firebase.apps

*Defined in [services/firebase.ts:7](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase.ts#L7)*
*Defined in [services/firebase.ts:7](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase.ts#L7)*

___

Expand All @@ -41,7 +41,7 @@ ___

**app**(name?: *`undefined` \| `string`*): `App`

*Defined in [services/firebase.ts:6](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase.ts#L6)*
*Defined in [services/firebase.ts:6](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase.ts#L6)*

**Parameters:**

Expand All @@ -58,7 +58,7 @@ ___

**initializeApp**(options: *`Object`*, nameOrConfig?: *`string` \| `Object`*): `App`

*Defined in [services/firebase.ts:8](https://github.com/firebase/emberfire/blob/v3/addon/services/firebase.ts#L8)*
*Defined in [services/firebase.ts:8](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/services/firebase.ts#L8)*

**Parameters:**

Expand Down
10 changes: 5 additions & 5 deletions docs/reference/classes/firebasesessionstore.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@

**● clear**: *`resolve`* = resolve

*Defined in [session-stores/firebase.ts:24](https://github.com/firebase/emberfire/blob/v3/addon/session-stores/firebase.ts#L24)*
*Defined in [session-stores/firebase.ts:24](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/session-stores/firebase.ts#L24)*

___
<a id="firebaseapp"></a>
Expand All @@ -40,7 +40,7 @@ ___

**● firebaseApp**: *`ComputedProperty`<[FirebaseAppService](firebaseappservice.md), [FirebaseAppService](firebaseappservice.md)>*

*Defined in [session-stores/firebase.ts:20](https://github.com/firebase/emberfire/blob/v3/addon/session-stores/firebase.ts#L20)*
*Defined in [session-stores/firebase.ts:20](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/session-stores/firebase.ts#L20)*

___
<a id="persist"></a>
Expand All @@ -49,7 +49,7 @@ ___

**● persist**: *`resolve`* = resolve

*Defined in [session-stores/firebase.ts:23](https://github.com/firebase/emberfire/blob/v3/addon/session-stores/firebase.ts#L23)*
*Defined in [session-stores/firebase.ts:23](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/session-stores/firebase.ts#L23)*

___
<a id="restoring"></a>
Expand All @@ -58,7 +58,7 @@ ___

**● restoring**: *`boolean`* = true

*Defined in [session-stores/firebase.ts:22](https://github.com/firebase/emberfire/blob/v3/addon/session-stores/firebase.ts#L22)*
*Defined in [session-stores/firebase.ts:22](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/session-stores/firebase.ts#L22)*

___

Expand All @@ -70,7 +70,7 @@ ___

**restore**(): `Promise`<`Object`>

*Defined in [session-stores/firebase.ts:26](https://github.com/firebase/emberfire/blob/v3/addon/session-stores/firebase.ts#L26)*
*Defined in [session-stores/firebase.ts:26](https://github.com/firebase/emberfire/blob/v3.0.0-rc.1/addon/session-stores/firebase.ts#L26)*

**Returns:** `Promise`<`Object`>

Expand Down
Loading

0 comments on commit d9ca37c

Please sign in to comment.