Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Improve Flow libdefs #845

Merged
merged 4 commits into from
Apr 18, 2016
Merged

Improve Flow libdefs #845

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
336a92a
Improve Flow libdefs
marudor Apr 18, 2016
e46e93a
typo
marudor Apr 18, 2016
4c620fa
Add any typeParam to make improve intent of it not being on the Itera…
marudor Apr 18, 2016
8902ca2
move filter to Iterable.
marudor Apr 18, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
70 changes: 46 additions & 24 deletions type-definitions/immutable.js.flow
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,9 +29,9 @@
*/
type ESIterable<T> = $Iterable<T,void,void>;

declare class Iterable<K, V> extends _Iterable<K, V, typeof KeyedIterable, typeof IndexedIterable, typeof SetIterable> {}
declare class Iterable<K, V> extends _Iterable<K, V, typeof KeyedIterable, typeof IndexedIterable, typeof SetIterable> {}

declare class _Iterable<K,V, KI, II, SI> {
declare class _Iterable<K, V, KI, II, SI> {
static Keyed: KI;
static Indexed: II;
static Set: SI;
Expand All @@ -44,16 +44,16 @@ declare class _Iterable<K,V, KI, II, SI> {

equals(other: Iterable<K,V>): boolean;
hashCode(): number;
get(key: K): V;
get<V_>(key: K, notSetValue: V_): V|V_;
get(key: K): ?V;
has(key: K): boolean;
includes(value: V): boolean;
contains(value: V): boolean;
first(): V;
last(): V;

getIn<T>(searchKeyPath: ESIterable<any>, notSetValue: T): T;
getIn<T>(searchKeyPath: ESIterable<any>): ?T;
getIn<T>(searchKeyPath: ESIterable<any>): T;
hasIn(searchKeyPath: ESIterable<any>): boolean;

toJS(): any;
Expand All @@ -78,16 +78,6 @@ declare class _Iterable<K,V, KI, II, SI> {
valueSeq(): IndexedSeq<V>;
entrySeq(): IndexedSeq<[K,V]>;

filter(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any
): this;

filterNot(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any
): this;

reverse(): this;
sort(comparator?: (valueA: V, valueB: V) => number): this;

Expand Down Expand Up @@ -120,6 +110,16 @@ declare class _Iterable<K,V, KI, II, SI> {
flatten(depth?: number): /*this*/Iterable<any,any>;
flatten(shallow?: boolean): /*this*/Iterable<any,any>;

filter(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any
): this;

filterNot(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any
): this;

reduce<R>(
reducer: (reduction: R, value: V, key: K, iter: this) => R,
initialReduction?: R,
Expand All @@ -139,25 +139,26 @@ declare class _Iterable<K,V, KI, II, SI> {
count(predicate?: (value: V, key: K, iter: this) => mixed, context?: any): number;
countBy<G>(grouper: (value: V, key: K, iter: this) => G, context?: any): Map<G,number>;

find(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any,
): ?V;
find<V_>(
predicate: (value: V, key: K, iter: this) => mixed,
context: any,
notSetValue: V_
): V|V_;
find<V_>(

findLast(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any,
): ?V;

findLast<V_>(
predicate: (value: V, key: K, iter: this) => mixed,
context: any,
notSetValue: V_
): V|V_;
findLast<V_>(
predicate: (value: V, key: K, iter: this) => mixed,
context?: any,
): ?V;


findEntry(predicate: (value: V, key: K, iter: this) => mixed): ?[K,V];
findLastEntry(predicate: (value: V, key: K, iter: this) => mixed): ?[K,V];
Expand Down Expand Up @@ -214,6 +215,9 @@ declare class KeyedIterable<K,V> extends Iterable<K,V> {
mapper: (value: V, key: K, iter: this) => ESIterable<[K_,V_]>,
context?: any
): /*this*/KeyedIterable<K_,V_>;

flatten(depth?: number): /*this*/KeyedIterable<any,any>;
flatten(shallow?: boolean): /*this*/KeyedIterable<any,any>;
}

declare class IndexedIterable<T> extends Iterable<number,T> {
Expand Down Expand Up @@ -319,6 +323,9 @@ declare class IndexedIterable<T> extends Iterable<number,T> {
mapper: (value: T, index: number, iter: this) => ESIterable<U>,
context?: any
): /*this*/IndexedIterable<U>;

flatten(depth?: number): /*this*/IndexedIterable<any>;
flatten(shallow?: boolean): /*this*/IndexedIterable<any>;
}

declare class SetIterable<T> extends Iterable<T,T> {
Expand All @@ -342,9 +349,12 @@ declare class SetIterable<T> extends Iterable<T,T> {
mapper: (value: T, value: T, iter: this) => ESIterable<U>,
context?: any
): /*this*/SetIterable<U>;

flatten(depth?: number): /*this*/SetIterable<any>;
flatten(shallow?: boolean): /*this*/SetIterable<any>;
}

declare class Collection<K,V> extends _Iterable<K,V, typeof KeyedCollection, typeof IndexedCollection, typeof SetCollection> {
declare class Collection<K,V> extends _Iterable<K,V, typeof KeyedCollection, typeof IndexedCollection, typeof SetCollection> {
size: number;
}

Expand Down Expand Up @@ -390,7 +400,7 @@ declare class SetSeq<T> extends Seq<T,T> mixins SetIterable<T> {
}

declare class List<T> extends IndexedCollection<T> {
static <T>(iterable?: ESIterable<T>): List<T>;
static (iterable?: ESIterable<T>): List<T>;
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should this still have <T>?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Not needed - optional. As the List itself already has T we do not need to bind a T to the function.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

should other static methods have the same style then? when do we use <T> on a static vs not use it?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We need it when we bind another dynamic type.

declare class Foo<T> {
 static (param: T): Foo<T>; //not needed.
 static <T_>(param: T, cb: (p: T, extra: T_) => T_): Foo<T> // needed - but only T_ not T.
}

The TypeParam of the class we define the static on is implicitly available.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Gotcha, was just noticing static of<T> right below this one - was just curious why you decided to edit this in this diff, but not any others like it.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Probably because I edited that constructor in my edits and just did not edit the other ones.
Although I ended up with exactly the same constructor I still rewrote it.
Gonna remove them everywhere.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

No sweat - just my curiosity!


static isList(maybeList: any): boolean;
static of<T>(...values: T[]): List<T>;
Expand Down Expand Up @@ -439,7 +449,6 @@ declare class List<T> extends IndexedCollection<T> {
asImmutable(): this;

// Overrides that specialize return types

map<M>(
mapper: (value: T, index: number, iter: this) => M,
context?: any
Expand All @@ -449,15 +458,19 @@ declare class List<T> extends IndexedCollection<T> {
mapper: (value: T, index: number, iter: this) => ESIterable<M>,
context?: any
): List<M>;

flatten(depth?: number): /*this*/List<any>;
flatten(shallow?: boolean): /*this*/List<any>;
}

declare class Map<K,V> extends KeyedCollection<K,V> {
static <K, V>(): Map<K, V>;
static <V>(obj?: {[key: string]: V}): Map<string, V>;
static <K, V>(iterable?: ESIterable<[K,V]>): Map<K, V>;

static isMap(maybeMap: any): boolean;

set<K_,V_>(key: K_, value: V_): Map<K|K_,V|V_>;
set<K_, V_>(key: K_, value: V_): Map<K|K_, V|V_>;
delete(key: K): this;
remove(key: K): this;
clear(): this;
Expand Down Expand Up @@ -516,6 +529,9 @@ declare class Map<K,V> extends KeyedCollection<K,V> {
mapper: (key: K, value: V, iter: this) => K_,
context?: any
): Map<K_,V>;

flatten(depth?: number): /*this*/Map<any,any>;
flatten(shallow?: boolean): /*this*/Map<any,any>;
}

// OrderedMaps have nothing that Maps do not have. We do not need to override constructor & other statics
Expand Down Expand Up @@ -555,6 +571,9 @@ declare class Set<T> extends SetCollection<T> {
mapper: (value: T, value: T, iter: this) => ESIterable<M>,
context?: any
): Set<M>;

flatten(depth?: number): /*this*/Set<any>;
flatten(shallow?: boolean): /*this*/Set<any>;
}

// OrderedSets have nothing that Sets do not have. We do not need to override constructor & other statics
Expand Down Expand Up @@ -592,6 +611,9 @@ declare class Stack<T> extends IndexedCollection<T> {
mapper: (value: T, index: number, iter: this) => ESIterable<U>,
context?: any
): Stack<U>;

flatten(depth?: number): /*this*/Stack<any>;
flatten(shallow?: boolean): /*this*/Stack<any>;
}

declare function Range(start?: number, end?: number, step?: number): IndexedSeq<number>;
Expand Down