Allow null queries (fixes jakearchibald#211)

philkunz · Jan 6, 2021 · 3437ff9 · 3437ff9
1 parent 5fddd5f
commit 3437ff9
Show file tree

Hide file tree

Showing 3 changed files with 49 additions and 47 deletions.
diff --git a/src/entry.ts b/src/entry.ts
@@ -313,7 +313,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
    */
   count<Name extends StoreNames<DBTypes>>(
     storeName: Name,
-    key?: StoreKey<DBTypes, Name> | IDBKeyRange,
+    key?: StoreKey<DBTypes, Name> | IDBKeyRange | null,
   ): Promise<number>;
   /**
    * Retrieves the number of records matching the given query in an index.
@@ -331,7 +331,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
   >(
     storeName: Name,
     indexName: IndexName,
-    key?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange,
+    key?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange | null,
   ): Promise<number>;
   /**
    * Deletes records in a store matching the given query.
@@ -393,7 +393,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
    */
   getAll<Name extends StoreNames<DBTypes>>(
     storeName: Name,
-    query?: StoreKey<DBTypes, Name> | IDBKeyRange,
+    query?: StoreKey<DBTypes, Name> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreValue<DBTypes, Name>[]>;
   /**
@@ -413,7 +413,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
   >(
     storeName: Name,
     indexName: IndexName,
-    query?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreValue<DBTypes, Name>[]>;
   /**
@@ -428,7 +428,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
    */
   getAllKeys<Name extends StoreNames<DBTypes>>(
     storeName: Name,
-    query?: StoreKey<DBTypes, Name> | IDBKeyRange,
+    query?: StoreKey<DBTypes, Name> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreKey<DBTypes, Name>[]>;
   /**
@@ -448,7 +448,7 @@ export interface IDBPDatabase<DBTypes extends DBSchema | unknown = unknown>
   >(
     storeName: Name,
     indexName: IndexName,
-    query?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, Name, IndexName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreKey<DBTypes, Name>[]>;
   /**
@@ -596,7 +596,9 @@ export interface IDBPObjectStore<
   /**
    * Retrieves the number of records matching the given query.
    */
-  count(key?: StoreKey<DBTypes, StoreName> | IDBKeyRange): Promise<number>;
+  count(
+    key?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
+  ): Promise<number>;
   /**
    * Creates a new index in store.
    *
@@ -630,7 +632,7 @@ export interface IDBPObjectStore<
    * @param count Maximum number of values to return.
    */
   getAll(
-    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange,
+    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreValue<DBTypes, StoreName>[]>;
   /**
@@ -640,7 +642,7 @@ export interface IDBPObjectStore<
    * @param count Maximum number of keys to return.
    */
   getAllKeys(
-    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange,
+    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreKey<DBTypes, StoreName>[]>;
   /**
@@ -666,7 +668,7 @@ export interface IDBPObjectStore<
    * @param direction
    */
   openCursor(
-    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange,
+    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): Promise<IDBPCursorWithValue<
     DBTypes,
@@ -684,7 +686,7 @@ export interface IDBPObjectStore<
    * @param direction
    */
   openKeyCursor(
-    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange,
+    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): Promise<IDBPCursor<DBTypes, TxStores, StoreName, unknown, Mode> | null>;
   /**
@@ -717,7 +719,7 @@ export interface IDBPObjectStore<
    * @param direction
    */
   iterate(
-    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange,
+    query?: StoreKey<DBTypes, StoreName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): AsyncIterableIterator<
     IDBPCursorWithValueIteratorValue<
@@ -761,7 +763,7 @@ export interface IDBPIndex<
    * Retrieves the number of records matching the given query.
    */
   count(
-    key?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    key?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
   ): Promise<number>;
   /**
    * Retrieves the value of the first record matching the query.
@@ -778,7 +780,7 @@ export interface IDBPIndex<
    * @param count Maximum number of values to return.
    */
   getAll(
-    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreValue<DBTypes, StoreName>[]>;
   /**
@@ -788,7 +790,7 @@ export interface IDBPIndex<
    * @param count Maximum number of keys to return.
    */
   getAllKeys(
-    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
     count?: number,
   ): Promise<StoreKey<DBTypes, StoreName>[]>;
   /**
@@ -808,7 +810,7 @@ export interface IDBPIndex<
    * @param direction
    */
   openCursor(
-    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): Promise<IDBPCursorWithValue<
     DBTypes,
@@ -826,7 +828,7 @@ export interface IDBPIndex<
    * @param direction
    */
   openKeyCursor(
-    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): Promise<IDBPCursor<DBTypes, TxStores, StoreName, IndexName, Mode> | null>;
   /**
@@ -850,7 +852,7 @@ export interface IDBPIndex<
    * @param direction
    */
   iterate(
-    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange,
+    query?: IndexKey<DBTypes, StoreName, IndexName> | IDBKeyRange | null,
     direction?: IDBCursorDirection,
   ): AsyncIterableIterator<
     IDBPCursorWithValueIteratorValue<

diff --git a/test/iterate.ts b/test/iterate.ts
@@ -100,7 +100,7 @@ suite('Async iterators', () => {
       typeAssert<
         IsExact<
           Parameters<typeof store.iterate>[0],
-          string | IDBKeyRange | undefined
+          string | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -114,7 +114,7 @@ suite('Async iterators', () => {
       typeAssert<
         IsExact<
           Parameters<typeof store.iterate>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -279,7 +279,7 @@ suite('Async iterators', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.iterate>[0],
-          Date | IDBKeyRange | undefined
+          Date | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -294,7 +294,7 @@ suite('Async iterators', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.iterate>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);
 

diff --git a/test/main.ts b/test/main.ts
@@ -1029,7 +1029,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store1.count>[0],
-        string | IDBKeyRange | undefined
+        string | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1044,7 +1044,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store2.count>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1070,12 +1070,12 @@ suite('IDBPObjectStore', () => {
     db = (await openDB(dbName, getNextVersion(), {
       upgrade(db, oldVersion, newVersion, tx) {
         const store = db.createObjectStore('object-store');
-        typeAssert<
-          IsExact<Parameters<typeof store.createIndex>[0], string>
-        >(true);
+        typeAssert<IsExact<Parameters<typeof store.createIndex>[0], string>>(
+          true,
+        );
       },
-    })) as IDBPDatabase;        
-  });  
+    })) as IDBPDatabase;
+  });
 
   test('delete', async () => {
     const schemaDB = await openDBWithData();
@@ -1143,7 +1143,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store1.getAll>[0],
-        string | IDBKeyRange | undefined
+        string | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1158,7 +1158,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store2.getAll>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1179,7 +1179,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store1.getAllKeys>[0],
-        string | IDBKeyRange | undefined
+        string | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1198,7 +1198,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store2.getAllKeys>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1267,7 +1267,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store1.openCursor>[0],
-        string | IDBKeyRange | undefined
+        string | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1292,7 +1292,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store2.openCursor>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1323,7 +1323,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store1.openKeyCursor>[0],
-        string | IDBKeyRange | undefined
+        string | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1346,7 +1346,7 @@ suite('IDBPObjectStore', () => {
     typeAssert<
       IsExact<
         Parameters<typeof store2.openKeyCursor>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1546,7 +1546,7 @@ suite('IDBPIndex', () => {
     typeAssert<
       IsExact<
         Parameters<typeof index1.count>[0],
-        Date | IDBKeyRange | undefined
+        Date | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1561,7 +1561,7 @@ suite('IDBPIndex', () => {
     typeAssert<
       IsExact<
         Parameters<typeof index2.count>[0],
-        IDBValidKey | IDBKeyRange | undefined
+        IDBValidKey | IDBKeyRange | undefined | null
       >
     >(true);
 
@@ -1628,7 +1628,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.getAll>[0],
-          Date | IDBKeyRange | undefined
+          Date | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1670,7 +1670,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.getAll>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1718,7 +1718,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.getAllKeys>[0],
-          Date | IDBKeyRange | undefined
+          Date | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1735,7 +1735,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.getAllKeys>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1792,7 +1792,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.openCursor>[0],
-          Date | IDBKeyRange | undefined
+          Date | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1819,7 +1819,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.openCursor>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1851,7 +1851,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.openKeyCursor>[0],
-          Date | IDBKeyRange | undefined
+          Date | IDBKeyRange | undefined | null
         >
       >(true);
 
@@ -1878,7 +1878,7 @@ suite('IDBPIndex', () => {
       typeAssert<
         IsExact<
           Parameters<typeof index.openKeyCursor>[0],
-          IDBValidKey | IDBKeyRange | undefined
+          IDBValidKey | IDBKeyRange | undefined | null
         >
       >(true);