Skip to content

Commit 52db807

Browse files
leebyronleebyron
committed
Clarify some aliases
1 parent 02f1f23 commit 52db807

File tree

2 files changed

+40
-30
lines changed

2 files changed

+40
-30
lines changed

‎dist/immutable.d.ts

+20-15
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,10 @@ declare module 'immutable' {
140140
* List. `v.delete(-1)` deletes the last item in the List.
141141
*
142142
* Note: `delete` cannot be safely used in IE8
143-
* @alias delete
143+
* @alias remove
144144
*/
145-
remove(index: number): List<T>;
146145
delete(index: number): List<T>;
146+
remove(index: number): List<T>;
147147

148148
/**
149149
* Returns a new List with 0 size and no values.
@@ -404,10 +404,10 @@ declare module 'immutable' {
404404
*
405405
* Note: `delete` cannot be safely used in IE8, but is provided to mirror
406406
* the ES6 collection API.
407-
* @alias delete
407+
* @alias remove
408408
*/
409-
remove(key: K): Map<K, V>;
410409
delete(key: K): Map<K, V>;
410+
remove(key: K): Map<K, V>;
411411

412412
/**
413413
* Returns a new Map containing no keys or values.
@@ -736,29 +736,26 @@ declare module 'immutable' {
736736
* Returns a new Set which excludes this value.
737737
*
738738
* Note: `delete` cannot be safely used in IE8
739-
* @alias delete
739+
* @alias remove
740740
*/
741-
remove(value: T): Set<T>;
742741
delete(value: T): Set<T>;
742+
remove(value: T): Set<T>;
743743

744744
/**
745745
* Returns a new Set containing no values.
746746
*/
747747
clear(): Set<T>;
748748

749-
/**
750-
* Alias for `union`.
751-
* @see `Map.prototype.merge`
752-
*/
753-
merge(...iterables: Iterable<any, T>[]): Set<T>;
754-
merge(...iterables: Array<T>[]): Set<T>;
755-
756749
/**
757750
* Returns a Set including any value from `iterables` that does not already
758751
* exist in this Set.
752+
* @alias merge
759753
*/
760754
union(...iterables: Iterable<any, T>[]): Set<T>;
761755
union(...iterables: Array<T>[]): Set<T>;
756+
merge(...iterables: Iterable<any, T>[]): Set<T>;
757+
merge(...iterables: Array<T>[]): Set<T>;
758+
762759

763760
/**
764761
* Returns a Set which has removed any values not also contained
@@ -1993,7 +1990,11 @@ declare module 'immutable' {
19931990
*
19941991
*/
19951992
mapEntries<KM, VM>(
1996-
mapper: (entry?: /*(K, V)*/Array<any>, index?: number, iter?: /*this*/KeyedIterable<K, V>) => /*[KM, VM]*/Array<any>,
1993+
mapper: (
1994+
entry?: /*(K, V)*/Array<any>,
1995+
index?: number,
1996+
iter?: /*this*/KeyedIterable<K, V>
1997+
) => /*[KM, VM]*/Array<any>,
19971998
context?: any
19981999
): /*this*/KeyedIterable<KM, VM>;
19992000

@@ -2219,7 +2220,11 @@ declare module 'immutable' {
22192220

22202221

22212222
/**
2222-
* ES6 Iterator
2223+
* ES6 Iterator.
2224+
*
2225+
* This is not part of the Immutable library, but a common interface used by
2226+
* many types in ES6 JavaScript
2227+
*
22232228
* @ignore
22242229
*/
22252230
export interface Iterator<T> {

‎type-definitions/Immutable.d.ts

+20-15
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,10 @@ declare module 'immutable' {
140140
* List. `v.delete(-1)` deletes the last item in the List.
141141
*
142142
* Note: `delete` cannot be safely used in IE8
143-
* @alias delete
143+
* @alias remove
144144
*/
145-
remove(index: number): List<T>;
146145
delete(index: number): List<T>;
146+
remove(index: number): List<T>;
147147

148148
/**
149149
* Returns a new List with 0 size and no values.
@@ -404,10 +404,10 @@ declare module 'immutable' {
404404
*
405405
* Note: `delete` cannot be safely used in IE8, but is provided to mirror
406406
* the ES6 collection API.
407-
* @alias delete
407+
* @alias remove
408408
*/
409-
remove(key: K): Map<K, V>;
410409
delete(key: K): Map<K, V>;
410+
remove(key: K): Map<K, V>;
411411

412412
/**
413413
* Returns a new Map containing no keys or values.
@@ -736,29 +736,26 @@ declare module 'immutable' {
736736
* Returns a new Set which excludes this value.
737737
*
738738
* Note: `delete` cannot be safely used in IE8
739-
* @alias delete
739+
* @alias remove
740740
*/
741-
remove(value: T): Set<T>;
742741
delete(value: T): Set<T>;
742+
remove(value: T): Set<T>;
743743

744744
/**
745745
* Returns a new Set containing no values.
746746
*/
747747
clear(): Set<T>;
748748

749-
/**
750-
* Alias for `union`.
751-
* @see `Map.prototype.merge`
752-
*/
753-
merge(...iterables: Iterable<any, T>[]): Set<T>;
754-
merge(...iterables: Array<T>[]): Set<T>;
755-
756749
/**
757750
* Returns a Set including any value from `iterables` that does not already
758751
* exist in this Set.
752+
* @alias merge
759753
*/
760754
union(...iterables: Iterable<any, T>[]): Set<T>;
761755
union(...iterables: Array<T>[]): Set<T>;
756+
merge(...iterables: Iterable<any, T>[]): Set<T>;
757+
merge(...iterables: Array<T>[]): Set<T>;
758+
762759

763760
/**
764761
* Returns a Set which has removed any values not also contained
@@ -1993,7 +1990,11 @@ declare module 'immutable' {
19931990
*
19941991
*/
19951992
mapEntries<KM, VM>(
1996-
mapper: (entry?: /*(K, V)*/Array<any>, index?: number, iter?: /*this*/KeyedIterable<K, V>) => /*[KM, VM]*/Array<any>,
1993+
mapper: (
1994+
entry?: /*(K, V)*/Array<any>,
1995+
index?: number,
1996+
iter?: /*this*/KeyedIterable<K, V>
1997+
) => /*[KM, VM]*/Array<any>,
19971998
context?: any
19981999
): /*this*/KeyedIterable<KM, VM>;
19992000

@@ -2219,7 +2220,11 @@ declare module 'immutable' {
22192220

22202221

22212222
/**
2222-
* ES6 Iterator
2223+
* ES6 Iterator.
2224+
*
2225+
* This is not part of the Immutable library, but a common interface used by
2226+
* many types in ES6 JavaScript
2227+
*
22232228
* @ignore
22242229
*/
22252230
export interface Iterator<T> {

0 commit comments

Comments
 (0)