8000 docs · rvrobotics/immutable-js@4fecef1 · GitHub
[go: up one dir, main page]

Skip to content

Commit 4fecef1

Browse files
committed
docs
1 parent 3725767 commit 4fecef1

File tree

1 file changed

+9
-9
lines changed

1 file changed

+9
-9
lines changed

type-definitions/Immutable.d.ts

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -767,8 +767,8 @@ export declare module Map {
767767
function empty<K, V>(): Map<K, V>;
768768

769769
/**
770-
* `Map.from()` creates a new immutable map with the same key value
771-
* pairs as the provided object.
770+
* `Map.from()` creates a new immutable Map with the same key value pairs as
771+
* the provided JavaScript Object, Array or Sequence.
772772
*
773773
* var newMap = Map.from({key: "value"});
774774
*
@@ -779,12 +779,12 @@ export declare module Map {
779779
}
780780

781781
/**
782-
* Alias for Map.empty().
782+
* Alias for `Map.empty()`.
783783
*/
784784
export declare function Map<K, V>(): Map<K, V>;
785785

786786
/**
787-
* Alias for Map.from().
787+
* Alias for `Map.from()`.
788788
*/
789789
export declare function Map<V>(object: {[key: string]: V}): Map<string, V>;
790790
export declare function Map<V>(array: Array<V>): Map<number, V>;
@@ -925,13 +925,13 @@ export interface Map<K, V> extends Sequence<K, V> {
925925
export declare module OrderedMap {
926926

927927
/**
928-
* OrderedMap.empty() creates a new immutable ordered map of length 0.
928+
* `OrderedMap.empty()` creates a new immutable ordered Map of length 0.
929929
*/
930930
function empty<K, V>(): Map<K, V>;
931931

932932
/**
933-
* Creates a new immutable ordered map with the same
934-
* key value pairs as the provided object.
933+
* `OrderedMap.from()` creates a new immutable ordered Map with the same key
934+
* value pairs as the provided JavaScript Object, Array or Sequence.
935935
*
936936
* var newMap = OrderedMap.from({key: "value"});
937937
*
@@ -942,12 +942,12 @@ export declare module OrderedMap {
942942
}
943943

944944
/**
945-
* Alias for OrderedMap.empty().
945+
* Alias for `OrderedMap.empty()`.
946946
*/
947947
export declare function OrderedMap<K, V>(): Map<K, V>;
948948

949949
/**
950-
* Alias for OrderedMap.from().
950+
* Alias for `OrderedMap.from()`.
951951
*/
952952
export declare function OrderedMap<V>(object: {[key: string]: V}): Map<string, V>;
953953
export declare function OrderedMap<V>(array: Array<V>): Map<number, V>;

0 commit comments

Comments
 (0)
0