update docs script

This commit is contained in:
jhuleatt
2019-04-22 11:09:08 -07:00
parent ac1dbf24a0
commit 169f83ecd2
2 changed files with 62 additions and 2 deletions

View File

@@ -13,12 +13,56 @@ or, if you don't want to deal with Suspense, pass an
## Interfaces
### AuthCheckProps
|Property|Type|
|---|---|
|auth|Auth|
|children|React.Component|
|fallback|React.Component|
|requiredClaims|Object|
### SuspensePerfProps
|Property|Type|
|---|---|
|children|React.Component|
|fallback|React.Component|
|firePerf|any|
|traceId|string|
### ReactFireOptions
|Property|Type|
|---|---|
|startWithValue|any|
## Components
### `AuthCheck`
#### Props
interface `AuthCheckProps`
#### Returns
React.FunctionComponent
### `SuspenseWithPerf`
#### Props
interface `SuspensePerfProps`
#### Returns
React.FunctionComponent
## Hooks
### `useDatabaseList`
@@ -127,6 +171,22 @@ Subscribe to Firebase auth state changes, including token refresh
User
### `useObservable`
#### Parameters
|Parameter|Type|
|---|---|
|observable$|Observable|
|observableId|string|
|startWithValue *?*|any|
#### Returns
any
## For development

View File

@@ -6,8 +6,6 @@ import { useObservable } from './util/use-observable';
import { getDownloadURL } from 'rxfire/storage';
import { Observable, from } from 'rxjs';
export { SuspenseWithPerf, AuthCheck } from './components';
export interface ReactFireOptions {
startWithValue: any;
}
@@ -150,3 +148,5 @@ export function useStorageDownloadURL(
options ? options.startWithValue : undefined
);
}
export { SuspenseWithPerf, AuthCheck } from './components';