Merge pull request #17 from extend-chrome/beta

README.md

@@ -33,6 +33,7 @@ This is a wrapper for the Chrome Extension Storage API that adds
 - [API](#api)
   - [interface Bucket](#api-bucket)
     - [bucket.get()](#api-bucket-get)
+    - [bucket.getKeys()](#api-bucket-getKeys)
     - [bucket.set()](#api-bucket-set)
     - [bucket.remove()](#api-bucket-remove)
     - [bucket.clear()](#api-bucket-clear)
@@ -259,6 +260,19 @@ bucket.get({ a: 123 }) // same, but 123 is default value
 bucket.get(({ a }) => a) // resolves to value of "a"
 ```
 
+## async function `bucket.getKeys` <a name = "api-bucket-getKeys"></a>
+
+Takes an optional getter. Resolves to an array of strings that represents the keys of the values in the storage area bucket.
+
+```typescript
+function getKeys() => Promise<string[]>
+```
+
+```typescript
+bucket.set({ a: 123 })
+bucket.getKeys() // Resolves to ['a']
+```
+
 ## async function `bucket.set` <a name = "api-bucket-set"></a>
 
 Set a value or values in storage. Takes a setter `object` or

package.json

@@ -1,6 +1,6 @@
 {
   "name": "@extend-chrome/storage",
-  "version": "1.4.5",
+  "version": "1.5.0-0",
   "description": "This is a wrapper for the Chrome Extension Storage API that adds promises and functional set transactions similar to the React `this.setState` API. Functional set transactions make it easy to use the Chrome Storage API to share and manage state between different contexts in a Chrome Extension.",
   "repository": "extend-chrome/storage",
   "license": "MIT",

src/bucket/index.ts

@@ -1,16 +1,17 @@
-import chromep from 'chrome-promise'
-import { chromepApi } from 'chrome-promise/chrome-promise'
-import { concat, from, fromEventPattern } from 'rxjs'
-import { filter, map, mergeMap } from 'rxjs/operators'
-import { isNonNull } from '../guards'
 import {
   AreaName,
   Bucket,
   Changes,
   CoreGetter,
   Getter,
 } from '../types'
+import { concat, from, fromEventPattern } from 'rxjs'
+import { filter, map, mergeMap } from 'rxjs/operators'
+
+import chromep from 'chrome-promise'
+import { chromepApi } from 'chrome-promise/chrome-promise'
 import { invalidSetterReturn } from '../validate'
+import { isNonNull } from '../guards'
 
 export { Bucket }
 
@@ -290,6 +291,10 @@ export function getBucket<T extends Record<string, any>>(
       return set(result)
     },
 
+    async getKeys() {
+      return getKeys()
+    },
+
     get changeStream() {
       return changeStream
     },

src/jest/jest-mock.test.ts

@@ -1,6 +1,7 @@
-import { Subject } from 'rxjs'
 import { getBucket, storage } from './jest-mock'
+
 import { MockBucket } from './jest-mock'
+import { Subject } from 'rxjs'
 
 jest.mock('../index.ts')
 
@@ -17,6 +18,7 @@ test('storage.local is mocked', async () => {
     update: expect.any(MockInstance),
     remove: expect.any(MockInstance),
     clear: expect.any(MockInstance),
+    getKeys: expect.any(MockInstance),
     changeStream: expect.any(Subject),
     valueStream: expect.any(Subject),
   })
@@ -42,12 +44,13 @@ test('getBucket returns MockBucket', async () => {
     update: expect.any(MockInstance),
     remove: expect.any(MockInstance),
     clear: expect.any(MockInstance),
+    getKeys: expect.any(MockInstance),
     changeStream: expect.any(Subject),
     valueStream: expect.any(Subject),
   })
 
   const defaultValue = { a: 'a', b: 1 }
-  
+
   mockStorageArea.get.mockImplementation(async () => {
     return defaultValue
   })

src/jest/jest-mock.ts

@@ -1,6 +1,7 @@
+import { Bucket, Changes } from '..'
+
 /* eslint-disable @typescript-eslint/no-unused-vars */
 import { Subject } from 'rxjs'
-import { Bucket, Changes } from '..'
 
 /**
  * This module is a pre-mocked version of storage for use with Jest.
@@ -37,6 +38,7 @@ export const getBucket = <T extends object>(
   update: jest.fn(),
   remove: jest.fn(),
   clear: jest.fn(),
+  getKeys: jest.fn(),
   changeStream: new Subject<Changes<T>>(),
   valueStream: new Subject<T>(),
 })

src/types.ts

@@ -65,6 +65,8 @@ export interface Bucket<T extends object> {
   remove: (query: string | string[]) => Promise<void>
   /** Clear the storage area */
   clear: () => Promise<void>
+  /** Get the keys (or property names) of the storage area */
+  getKeys: () => Promise<string[]>
   /** Emits an object with changed storage keys and StorageChange values  */
   readonly changeStream: Observable<Changes<T>>
   /** Emits the current storage values immediately and when changeStream emits */