Merge pull request #413 from aparzi/issue-372

Issue 372
assuncaocharles · Nov 17, 2024 · 7e1c325 · 7e1c325
2 parents 3c2b926 + b5951f1
commit 7e1c325
Show file tree

Hide file tree

Showing 3 changed files with 5 additions and 4 deletions.
diff --git a/README.md b/README.md
@@ -347,7 +347,7 @@ Returns the open cursor event
 
 ```js
 this.dbService.openCursor('people', IDBKeyRange.bound("A", "F")).subscribe((evt) => {
-    var cursor = (evt.target as IDBOpenDBRequest).result;
+    const cursor = (evt.target as IDBOpenDBRequest).result as unknown as IDBCursorWithValue;
     if(cursor) {
         console.log(cursor.value);
         cursor.continue();
@@ -369,7 +369,7 @@ Open a cursor by index filter.
 
 ```js
 this.dbService.openCursorByIndex('people', 'name', IDBKeyRange.only('john')).subscribe((evt) => {
-    var cursor = (evt.target as IDBOpenDBRequest).result;
+    const cursor = (evt.target as IDBOpenDBRequest).result as unknown as IDBCursorWithValue;
     if(cursor) {
         console.log(cursor.value);
         cursor.continue();

diff --git a/projects/ngx-indexed-db/README.md b/projects/ngx-indexed-db/README.md
@@ -346,7 +346,7 @@ Returns the open cursor event
 
 ```js
 this.dbService.openCursor('people', IDBKeyRange.bound("A", "F")).subscribe((evt) => {
-    var cursor = (evt.target as IDBOpenDBRequest).result;
+    const cursor = (evt.target as IDBOpenDBRequest).result as unknown as IDBCursorWithValue;
     if(cursor) {
         console.log(cursor.value);
         cursor.continue();
@@ -368,7 +368,7 @@ Open a cursor by index filter.
 
 ```js
 this.dbService.openCursorByIndex('people', 'name', IDBKeyRange.only('john')).subscribe((evt) => {
-    var cursor = (evt.target as IDBOpenDBRequest).result;
+    const cursor = (evt.target as IDBOpenDBRequest).result as unknown as IDBCursorWithValue;
     if(cursor) {
         console.log(cursor.value);
         cursor.continue();

diff --git a/projects/ngx-indexed-db/src/lib/ngx-indexed-db.service.ts b/projects/ngx-indexed-db/src/lib/ngx-indexed-db.service.ts
@@ -527,6 +527,7 @@ export class NgxIndexedDBService {
    * Returns the open cursor event
    * @param storeName The name of the store to have the entries deleted
    * @param keyRange The key range which the cursor should be open on
+   * @param direction A string telling the cursor which direction to travel. The default is next
    */
   openCursor(storeName: string, keyRange?: IDBKeyRange, direction: IDBCursorDirection = 'next'): Observable<Event> {
     return new Observable((obs) => {