Classes

RxDBClientError

Custom error classes for RxDB client

Constructor

constructor(message: string, code: string, details?: any)

Parameters:

Parameter	Type	Required
`message`	`string`	Yes
`code`	`string`	Yes
`details`	`any`	No

ConnectionError

Constructor

constructor(message: string, details?: any)

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`details`	`any`	No

ReplicationError

Constructor

constructor(message: string, details?: any)

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`details`	`any`	No

ConfigurationError

Constructor

constructor(message: string, details?: any)

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`details`	`any`	No

NotSupportedError

Constructor

constructor(message: string, details?: any)

Parameters:

Parameter	Type	Required	Description
`message`	`string`	Yes
`details`	`any`	No

ReplicationClient

Replication-based RxDB client Uses local database with server replication

Constructor

constructor(config: ReplicationConfig<TCollections>)

Parameters:

Parameter	Type	Required	Description
`config`	`ReplicationConfig<TCollections>`	Yes

Methods

isConnected

isConnected(): boolean

Returns:

boolean -

connect

connect(): Promise<void>

Returns:

Promise<void> -

disconnect

disconnect(removeData?: boolean): Promise<void>

Parameters:

Parameter	Type	Required	Description
`removeData`	`boolean`	No

Returns:

Promise<void> -

RestClient

REST-based RxDB client Uses direct REST API calls instead of local database

Constructor

constructor(config: RestConfig<TCollections>)

Parameters:

Parameter	Type	Required	Description
`config`	`RestConfig<TCollections>`	Yes

Methods

isConnected

isConnected(): boolean

Returns:

boolean -

connect

connect(): Promise<void>

Returns:

Promise<void> -

disconnect

disconnect(_removeData?: boolean | undefined): Promise<void>

Parameters:

Parameter	Type	Required	Description
`_removeData`	`boolean \| undefined`	No

Returns:

Promise<void> -

updateAuthToken

Update the auth token for all REST clients Used for token refresh without reconnecting

updateAuthToken(newToken: string): void

Parameters:

Parameter	Type	Required	Description
`newToken`	`string`	Yes

CollectionWrapper

Wrapper around RxDB collection providing standardized interface

Constructor

constructor(collection: RxCollection<TDocument>)

Parameters:

Parameter	Type	Required	Description
`collection`	`RxCollection<TDocument>`	Yes

Methods

insert

insert(doc: TDocument): Promise<TDocument>

Parameters:

Parameter	Type	Required	Description
`doc`	`TDocument`	Yes

Returns:

Promise<TDocument> -

bulkInsert

bulkInsert(docs: TDocument[]): Promise<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`docs`	`TDocument[]`	Yes

Returns:

Promise<TDocument[]> -

findOne

findOne(query: Query<TDocument>): Promise<TDocument | null>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Promise<TDocument \| null> -

find

find(query: Query<TDocument>): Promise<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Promise<TDocument[]> -

update

update(id: string, updates: Partial<TDocument>): Promise<TDocument>

Parameters:

Parameter	Type	Required	Description
`id`	`string`	Yes
`updates`	`Partial<TDocument>`	Yes

Returns:

Promise<TDocument> -

delete

delete(id: string): Promise<boolean>

Parameters:

Parameter	Type	Required	Description
`id`	`string`	Yes

Returns:

Promise<boolean> -

findOne$

findOne$(query: Query<TDocument>): Observable<TDocument | null>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Observable<TDocument \| null> -

find$

find$(query: Query<TDocument>): Observable<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Observable<TDocument[]> -

getRxCollection

getRxCollection(): RxCollection<TDocument>

Returns:

RxCollection<TDocument> -

RestCollectionWrapper

Wrapper around REST client providing collection-like interface with client-side schema validation

Constructor

constructor(restClient: RxRestClient, collectionName: string, schema?: any)

Parameters:

Parameter	Type	Required
`restClient`	`RxRestClient`	Yes
`collectionName`	`string`	Yes
`schema`	`any`	No

Methods

insert

insert(doc: TDocument): Promise<TDocument>

Parameters:

Parameter	Type	Required	Description
`doc`	`TDocument`	Yes

Returns:

Promise<TDocument> -

bulkInsert

bulkInsert(docs: TDocument[]): Promise<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`docs`	`TDocument[]`	Yes

Returns:

Promise<TDocument[]> -

findOne

findOne(query: Query<TDocument>): Promise<TDocument | null>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Promise<TDocument \| null> -

find

find(query: Query<TDocument>): Promise<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`query`	`Query<TDocument>`	Yes

Returns:

Promise<TDocument[]> -

update

update(id: string, updates: Partial<TDocument>): Promise<TDocument>

Parameters:

Parameter	Type	Required	Description
`id`	`string`	Yes
`updates`	`Partial<TDocument>`	Yes

Returns:

Promise<TDocument> -

delete

delete(id: string): Promise<boolean>

Parameters:

Parameter	Type	Required	Description
`id`	`string`	Yes

Returns:

Promise<boolean> -

findOne$

findOne$(_query: Query<TDocument>): Observable<TDocument | null>

Parameters:

Parameter	Type	Required	Description
`_query`	`Query<TDocument>`	Yes

Returns:

Observable<TDocument \| null> -

find$

find$(_query: Query<TDocument>): Observable<TDocument[]>

Parameters:

Parameter	Type	Required	Description
`_query`	`Query<TDocument>`	Yes

Returns:

Observable<TDocument[]> -

getRxCollection

getRxCollection(): never

Returns:

never -

updateClient

Update the underlying REST client Used for token refresh without reconnecting

updateClient(newClient: RxRestClient): void

Parameters:

Parameter	Type	Required	Description
`newClient`	`RxRestClient`	Yes