ngx-dexie-observable

Dexie module for Angular 2.0+ projects

This is a fork of ngx-dexie with rxjs observable implementation

Install

npm install ngx-dexie-observable --save

How to use

Import and configure DexieModule

1//...
2import { DexieModule, DexieConfig } from 'ngx-dexie';
3
4const config: DexieConfig = {
5    databaseName: 'AppDatabase',//your database name here
6    schema: {
7        friends: '++id, first_name, last_name',
8        teachers: '++id, first_name, last_name'
9    } // any schema of your choice
10};
11
12@NgModule({
13    declarations: [
14        AppComponent
15    ],
16    imports: [
17        BrowserModule,
18        DexieModule.forRoot(config)
19    ],
20    providers: [
21
22    ],
23    bootstrap: [AppComponent]
24})
25
26export class AppModule { }

Using your dexie instance

The DexieModule provides now a configured Dexie db instance and a Dexie db service, i.e. DexieService which can be injected anywhere inside the AppModule.

1import { Injectable } from '@angular/core';
2import { DexieService } from 'ngx-dexie';
3
4@Injectable()
5export class IndexedDbService {
6
7    constructor(private dexieService: DexieService) {}
8
9    addOneFriend(friendObject: Object) {
10        this.dexieService.addOne('friends', friendObject);
11    }
12
13}

API

dexieService.addOne(table: string, object: Object)

Adds the entry object to the dexie table table Returns a promise which when resolved gives the key of the object added, when rejected gives the error that occured.

dexieService.addMultiple(table: string, objects: Object[])

Adds multiple objects to the dexie table table Returns a promise which works similar to Dexie bulkAdd()

dexieService.count(table: string)

Returns a promise which when resolved gives the number of objects in the table table

dexieService.addOrUpdateOne(table: string, object: Object, key?: any)

Works similar to Dexie put()

dexieService.addOrUpdateMultiple(table: string, objects: Object[], keys?: any)

Works similar to Dexie bulkPut()

dexieService.deleteOne(table: string, primaryKey: any)

Works similar to Dexie delete()

dexieService.deleteMultiple(table: string, primaryKeys: any[])

Works similar to Dexie bulkDelete()

dexieService.clearAll(table: string)

Works similar to Dexie clear()

dexieService.operateOnEach(table: string, callback: (item: any, idbCursor: any) => any)

Works similar to Dexie each()

dexieService.filter(table: string, filterFunction: (value: any) => boolean)

Works similar to Dexie filter()

dexieService.getByPrimaryKey(table: string, primaryKey: any, callback?: (item: Object) => any)

Works similar to Dexie get()

dexieService.getByKeyToValueMap(table: string, keyValueMap: Object, callback?: (item: Object) => any)

Works similar to Dexie get()

dexieService.getFirstNItemsOfTable(table: string, num: number)

Works similar to Dexie limit()

dexieService.orderBy(table: string, index: string)

Works similar to Dexie orderBy()

dexieService.offset(table: string, ignoreUpto: number)

Works similar to Dexie offset()

dexieService.reverse(table: string)

Works similar to Dexie reverse()

dexieService.toArray(table: string, callback?: (objects: Object[]) => any)

Works similar to Dexie toArray()

dexieService.toCollection(table: string)

Works similar to Dexie toCollection()

dexieService.update(table: string, key: any, changes: Object)

Works similar to Dexie update()