Functions

DBProvider

Database Provider Component

Provides RxDB instance to React components via context. Can auto-initialize from config or accept pre-initialized database.

Signature:

DBProvider(props: DBProviderProps): React.JSX.Element

Parameters:

Returns:

React.JSX.Element -

useDatabase

Hook to access database from context

Signature:

useDatabase(): DBContextValue

Returns:

DBContextValue -

useRxCollection

Signature:

useRxCollection(name: string): RxCollection<T> | null

Parameters:

Returns:

RxCollection<T> \| null -

useRxData

Convenience wrapper around useRxQuery that expects a collection name & a query constructor function

Signature:

useRxData(collectionName: string, queryConstructor: QueryConstructor<T> | undefined, options?: UseRxQueryOptions): RxQueryResult<T>

Parameters:

Returns:

RxQueryResult<T> -

useRxDB

Signature:

useRxDB(): RxDatabaseBaseExtended

Returns:

RxDatabaseBaseExtended -

useRxQuery

Subscribes to specified query and provides results, also providing:

• state indicators for fetching and list depletion
• a fetchMore callback function for pagination support
• a resetList callback function for conveniently reseting list data

Signature:

useRxQuery(query?: AnyRxQuery<T> | undefined, options?: UseRxQueryOptions): RxQueryResult<T>

Parameters:

Returns:

RxQueryResult<T> -