Merge pull request #272 from Ayc0/symbol

Symbols as keys

src/internals/helpers.ts

@@ -103,20 +103,22 @@ export const matchPattern = (
         : false;
     }
 
-    return Object.keys(pattern).every((k: string): boolean => {
-      // @ts-ignore
-      const subPattern = pattern[k];
-
-      return (
-        (k in value || isOptionalPattern(subPattern)) &&
-        matchPattern(
-          subPattern,
-          // @ts-ignore
-          value[k],
-          select
-        )
-      );
-    });
+    return (Object.keys(pattern) as Array<string | symbol>)
+      .concat(Object.getOwnPropertySymbols(pattern))
+      .every((k: string | symbol): boolean => {
+        // @ts-ignore
+        const subPattern = pattern[k];
+
+        return (
+          (k in value || isOptionalPattern(subPattern)) &&
+          matchPattern(
+            subPattern,
+            // @ts-ignore
+            value[k],
+            select
+          )
+        );
+      });
   }
 
   return Object.is(value, pattern);

tests/objects.test.ts

@@ -0,0 +1,28 @@
+import { isMatching, P } from '../src';
+import { Equal, Expect } from '../src/types/helpers';
+
+describe('Objects', () => {
+  it('should work with symbols', () => {
+    const symbolA = Symbol('symbol-a');
+    const symbolB = Symbol('symbol-b');
+    const obj: { [symbolA]: { [symbolB]: 'foo' | 'bar' } } = {
+      [symbolA]: { [symbolB]: 'foo' },
+    };
+    if (isMatching({ [symbolA]: { [symbolB]: 'foo' } }, obj)) {
+      type t = Expect<Equal<typeof obj, { [symbolA]: { [symbolB]: 'foo' } }>>;
+    } else {
+      throw new Error('Expected obj to match the foo pattern!');
+    }
+    if (isMatching({ [symbolA]: { [symbolB]: 'bar' } }, obj)) {
+      type t = Expect<
+        Equal<
+          typeof obj,
+          { [symbolA]: { [symbolB]: 'foo' } } & {
+            [symbolA]: { [symbolB]: 'bar' };
+          }
+        >
+      >;
+      throw new Error('Expected obj to not match the bar pattern!');
+    }
+  });
+});