Change Set key type back to never

sandersn · sandersn · commit b9ae2bdce74b · 2017-08-09T13:09:57.000-07:00
1. Set&lt;T&gt; once again extends Collection&lt;never, T&gt;.
2. pages/lib/TypeKind.js understands Never now.
3. Remove calls to Set.has and Set.get. These refer to the key type,
which is now `never`. Set.contains should be used instead of Set.has.
`if (Set.contains(x)) Set.get(x)` should be replaced with
`if (Set.contains(x)) x` since Sets shouldn't change the identity of
their items.
diff --git a/__tests__/Set.ts b/__tests__/Set.ts
@@ -263,7 +263,6 @@ describe('Set', () => {
       let symbolSet = Set([ a, b, c, a, b, c, a, b, c, a, b, c ]);
       expect(symbolSet.size).toBe(3);
       expect(symbolSet.contains(b)).toBe(true);
-      expect(symbolSet.get(c)).toEqual(c);
     });
 
     it('operates on a large number of symbols, maintaining obj uniqueness', () => {
@@ -277,7 +276,6 @@ describe('Set', () => {
       let symbolSet = Set(manySymbols);
       expect(symbolSet.size).toBe(12);
       expect(symbolSet.contains(manySymbols[10])).toBe(true);
-      expect(symbolSet.get(manySymbols[10])).toEqual(manySymbols[10]);
     });
 
   });
diff --git a/dist/immutable-nonambient.d.ts b/dist/immutable-nonambient.d.ts
@@ -1730,7 +1730,7 @@
      * value at every step.
      */
     map<M>(
-      mapper: (value: T, key: number, iter: this) => M,
+      mapper: (value: T, key: never, iter: this) => M,
       context?: any
     ): Set<M>;
 
@@ -1740,7 +1740,7 @@
      * Similar to `set.map(...).flatten(true)`.
      */
     flatMap<M>(
-      mapper: (value: T, key: number, iter: this) => Iterable<M>,
+      mapper: (value: T, key: never, iter: this) => Iterable<M>,
       context?: any
     ): Set<M>;
 
@@ -1752,11 +1752,11 @@
      * not filtering out any values.
      */
     filter<F extends T>(
-      predicate: (value: T, key: number, iter: this) => value is F,
+      predicate: (value: T, key: never, iter: this) => value is F,
       context?: any
     ): Set<F>;
     filter(
-      predicate: (value: T, key: number, iter: this) => any,
+      predicate: (value: T, key: never, iter: this) => any,
       context?: any
     ): this;
   }
@@ -1825,7 +1825,7 @@
      * value at every step.
      */
     map<M>(
-      mapper: (value: T, key: number, iter: this) => M,
+      mapper: (value: T, key: never, iter: this) => M,
       context?: any
     ): OrderedSet<M>;
 
@@ -1835,7 +1835,7 @@
      * Similar to `set.map(...).flatten(true)`.
      */
     flatMap<M>(
-      mapper: (value: T, key: number, iter: this) => Iterable<M>,
+      mapper: (value: T, key: never, iter: this) => Iterable<M>,
       context?: any
     ): OrderedSet<M>;
 
@@ -1847,11 +1847,11 @@
      * not filtering out any values.
      */
     filter<F extends T>(
-      predicate: (value: T, key: number, iter: this) => value is F,
+      predicate: (value: T, key: never, iter: this) => value is F,
       context?: any
     ): OrderedSet<F>;
     filter(
-      predicate: (value: T, key: number, iter: this) => any,
+      predicate: (value: T, key: never, iter: this) => any,
       context?: any
     ): this;
 
@@ -2670,7 +2670,7 @@
     export function Set<T>(): Seq.Set<T>;
     export function Set<T>(collection: Iterable<T>): Seq.Set<T>;
 
-    export interface Set<T> extends Seq<number, T>, Collection.Set<T> {
+    export interface Set<T> extends Seq<never, T>, Collection.Set<T> {
       /**
        * Deeply converts this Set Seq to equivalent native JavaScript Array.
        */
@@ -2707,7 +2707,7 @@
        * same value at every step.
        */
       map<M>(
-        mapper: (value: T, key: number, iter: this) => M,
+        mapper: (value: T, key: never, iter: this) => M,
         context?: any
       ): Seq.Set<M>;
 
@@ -2717,7 +2717,7 @@
        * Similar to `seq.map(...).flatten(true)`.
        */
       flatMap<M>(
-        mapper: (value: T, key: number, iter: this) => Iterable<M>,
+        mapper: (value: T, key: never, iter: this) => Iterable<M>,
         context?: any
       ): Seq.Set<M>;
 
@@ -2729,11 +2729,11 @@
        * not filtering out any values.
        */
       filter<F extends T>(
-        predicate: (value: T, key: number, iter: this) => value is F,
+        predicate: (value: T, key: never, iter: this) => value is F,
         context?: any
       ): Seq.Set<F>;
       filter(
-        predicate: (value: T, key: number, iter: this) => any,
+        predicate: (value: T, key: never, iter: this) => any,
         context?: any
       ): this;
     }
@@ -3294,7 +3294,7 @@
      */
     export function Set<T>(collection: Iterable<T>): Collection.Set<T>;
 
-    export interface Set<T> extends Collection<number, T> {
+    export interface Set<T> extends Collection<never, T> {
       /**
        * Deeply converts this Set collection to equivalent native JavaScript Array.
        */
@@ -3331,7 +3331,7 @@
        * same value at every step.
        */
       map<M>(
-        mapper: (value: T, key: number, iter: this) => M,
+        mapper: (value: T, key: never, iter: this) => M,
         context?: any
       ): Collection.Set<M>;
 
@@ -3341,7 +3341,7 @@
        * Similar to `collection.map(...).flatten(true)`.
        */
       flatMap<M>(
-        mapper: (value: T, key: number, iter: this) => Iterable<M>,
+        mapper: (value: T, key: never, iter: this) => Iterable<M>,
         context?: any
       ): Collection.Set<M>;
 
@@ -3353,11 +3353,11 @@
        * not filtering out any values.
        */
       filter<F extends T>(
-        predicate: (value: T, key: number, iter: this) => value is F,
+        predicate: (value: T, key: never, iter: this) => value is F,
         context?: any
       ): Collection.Set<F>;
       filter(
-        predicate: (value: T, key: number, iter: this) => any,
+        predicate: (value: T, key: never, iter: this) => any,
         context?: any
       ): this;
 
diff --git a/dist/immutable.d.ts b/dist/immutable.d.ts
@@ -1730,7 +1730,7 @@ declare module Immutable {
      * value at every step.
      */
     map<M>(
-      mapper: (value: T, key: number, iter: this) => M,
+      mapper: (value: T, key: never, iter: this) => M,
       context?: any
     ): Set<M>;
 
@@ -1740,7 +1740,7 @@ declare module Immutable {
      * Similar to `set.map(...).flatten(true)`.
      */
     flatMap<M>(
-      mapper: (value: T, key: number, iter: this) => Iterable<M>,
+      mapper: (value: T, key: never, iter: this) => Iterable<M>,
       context?: any
     ): Set<M>;
 
@@ -1752,11 +1752,11 @@ declare module Immutable {
      * not filtering out any values.
      */
     filter<F extends T>(
-      predicate: (value: T, key: number, iter: this) => value is F,
+      predicate: (value: T, key: never, iter: this) => value is F,
       context?: any
     ): Set<F>;
     filter(
-      predicate: (value: T, key: number, iter: this) => any,
+      predicate: (value: T, key: never, iter: this) => any,
       context?: any
     ): this;
   }
@@ -1825,7 +1825,7 @@ declare module Immutable {
      * value at every step.
      */
     map<M>(
-      mapper: (value: T, key: number, iter: this) => M,
+      mapper: (value: T, key: never, iter: this) => M,
       context?: any
     ): OrderedSet<M>;
 
@@ -1835,7 +1835,7 @@ declare module Immutable {
      * Similar to `set.map(...).flatten(true)`.
      */
     flatMap<M>(
-      mapper: (value: T, key: number, iter: this) => Iterable<M>,
+      mapper: (value: T, key: never, iter: this) => Iterable<M>,
       context?: any
     ): OrderedSet<M>;
 
@@ -1847,11 +1847,11 @@ declare module Immutable {
      * not filtering out any values.
      */
     filter<F extends T>(
-      predicate: (value: T, key: number, iter: this) => value is F,
+      predicate: (value: T, key: never, iter: this) => value is F,
       context?: any
     ): OrderedSet<F>;
     filter(
-      predicate: (value: T, key: number, iter: this) => any,
+      predicate: (value: T, key: never, iter: this) => any,
       context?: any
     ): this;
 
@@ -2670,7 +2670,7 @@ declare module Immutable {
     export function Set<T>(): Seq.Set<T>;
     export function Set<T>(collection: Iterable<T>): Seq.Set<T>;
 
-    export interface Set<T> extends Seq<number, T>, Collection.Set<T> {
+    export interface Set<T> extends Seq<never, T>, Collection.Set<T> {
       /**
        * Deeply converts this Set Seq to equivalent native JavaScript Array.
        */
@@ -2707,7 +2707,7 @@ declare module Immutable {
        * same value at every step.
        */
       map<M>(
-        mapper: (value: T, key: number, iter: this) => M,
+        mapper: (value: T, key: never, iter: this) => M,
         context?: any
       ): Seq.Set<M>;
 
@@ -2717,7 +2717,7 @@ declare module Immutable {
        * Similar to `seq.map(...).flatten(true)`.
        */
       flatMap<M>(
-        mapper: (value: T, key: number, iter: this) => Iterable<M>,
+        mapper: (value: T, key: never, iter: this) => Iterable<M>,
         context?: any
       ): Seq.Set<M>;
 
@@ -2729,11 +2729,11 @@ declare module Immutable {
        * not filtering out any values.
        */
       filter<F extends T>(
-        predicate: (value: T, key: number, iter: this) => value is F,
+        predicate: (value: T, key: never, iter: this) => value is F,
         context?: any
       ): Seq.Set<F>;
       filter(
-        predicate: (value: T, key: number, iter: this) => any,
+        predicate: (value: T, key: never, iter: this) => any,
         context?: any
       ): this;
     }
@@ -3294,7 +3294,7 @@ declare module Immutable {
      */
     export function Set<T>(collection: Iterable<T>): Collection.Set<T>;
 
-    export interface Set<T> extends Collection<number, T> {
+    export interface Set<T> extends Collection<never, T> {
       /**
        * Deeply converts this Set collection to equivalent native JavaScript Array.
        */
@@ -3331,7 +3331,7 @@ declare module Immutable {
        * same value at every step.
        */
       map<M>(
-        mapper: (value: T, key: number, iter: this) => M,
+        mapper: (value: T, key: never, iter: this) => M,
         context?: any
       ): Collection.Set<M>;
 
@@ -3341,7 +3341,7 @@ declare module Immutable {
        * Similar to `collection.map(...).flatten(true)`.
        */
       flatMap<M>(
-        mapper: (value: T, key: number, iter: this) => Iterable<M>,
+        mapper: (value: T, key: never, iter: this) => Iterable<M>,
         context?: any
       ): Collection.Set<M>;
 
@@ -3353,11 +3353,11 @@ declare module Immutable {
        * not filtering out any values.
        */
       filter<F extends T>(
-        predicate: (value: T, key: number, iter: this) => value is F,
+        predicate: (value: T, key: never, iter: this) => value is F,
         context?: any
       ): Collection.Set<F>;
       filter(
-        predicate: (value: T, key: number, iter: this) => any,
+        predicate: (value: T, key: never, iter: this) => any,
         context?: any
       ): this;
 
diff --git a/pages/lib/TypeKind.js b/pages/lib/TypeKind.js
@@ -6,17 +6,18 @@ var TypeKind = {
   String: 3,
   Object: 4,
   Array: 5,
-  Function: 6,
+  Never: 6,
+  Function: 7,
 
-  Param: 7,
-  Type: 8,
+  Param: 8,
+  Type: 9,
 
-  This: 9,
-  Undefined: 10,
-  Union: 11,
-  Tuple: 12,
-  Indexed: 13,
-  Operator: 14
+  This: 10,
+  Undefined: 11,
+  Union: 12,
+  Tuple: 13,
+  Indexed: 14,
+  Operator: 15
 };
 
 module.exports = TypeKind;
diff --git a/pages/lib/genTypeDefData.js b/pages/lib/genTypeDefData.js
@@ -262,6 +262,10 @@ function DocVisitor(source) {
 
   function parseType(node) {
     switch (node.kind) {
+      case ts.SyntaxKind.NeverKeyword:
+        return {
+          k: TypeKind.NeverKeyword
+        };
       case ts.SyntaxKind.AnyKeyword:
         return {
           k: TypeKind.Any
diff --git a/pages/src/docs/src/Defs.js b/pages/src/docs/src/Defs.js
@@ -80,6 +80,8 @@ var TypeDef = React.createClass({
     var type = this.props.type;
     var prefix = this.props.prefix;
     switch (type.k) {
+      case TypeKind.Never:
+        return this.wrap('primitive', 'never');
       case TypeKind.Any:
         return this.wrap('primitive', 'any');
       case TypeKind.This:
@@ -295,6 +297,8 @@ function typeLength(info, type) {
     throw new Error('Expected type');
   }
   switch (type.k) {
+    case TypeKind.Never:
+      return 5;
     case TypeKind.Any:
       return 3;
     case TypeKind.This:
diff --git a/type-definitions/Immutable.d.ts b/type-definitions/Immutable.d.ts
