Class Sort

Creates a Sort object.

Example

const sort = new Sort([['a', 'asc']]);
console.log([...sort]); // [['a', 'asc']]

Type Params

P - the allowed properties

Type Parameters

P extends string

Hierarchy

Map<P, SortDirection>
- Sort

Index

Constructors

constructor

new Sort(entries?: null | readonly (readonly [P, SortDirection])[]): Sort
Type Parameters
- P extends string
Parameters
- Optional entries: null | readonly (readonly [P, SortDirection])[]
Returns Sort
Inherited from Map<P, SortDirection>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:53
new Sort(iterable?: null | Iterable<readonly [P, SortDirection]>): Sort
Type Parameters
- P extends string
Parameters
- Optional iterable: null | Iterable<readonly [P, SortDirection]>
Returns Sort
Inherited from Map<P, SortDirection>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:161

Properties

`Readonly` [toStringTag]

[toStringTag]: string

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

[iterator]

[iterator](): IterableIterator<[P, SortDirection]>
Returns an iterable of entries in the map.

Returns IterableIterator<[P, SortDirection]>
Inherited from Map.__@iterator@21543
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:121

clear

clear(): void
Returns void
Inherited from Map.clear
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:23

delete

delete(key: P): boolean
Returns
true if an element in the Map existed and has been removed, or false if the element does not exist.
Parameters
- key: P
Returns boolean
Inherited from Map.delete
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:27

entries

entries(): IterableIterator<[P, SortDirection]>
Returns an iterable of key, value pairs for every entry in the map.

Returns IterableIterator<[P, SortDirection]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:126

forEach

forEach(callbackfn: ((value: SortDirection, key: P, map: Map<P, SortDirection>) => void), thisArg?: any): void
Executes a provided function once per each key/value pair in the Map, in insertion order.
Parameters
- callbackfn: ((value: SortDirection, key: P, map: Map<P, SortDirection>) => void)
 - - (value: SortDirection, key: P, map: Map<P, SortDirection>): void
 - Parameters
 
 value: SortDirection
 
 key: P
 
 map: Map<P, SortDirection>
 
 Returns void
- Optional thisArg: any
Returns void
Inherited from Map.forEach
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:31

get

get(key: P): undefined | SortDirection
Returns a specified element from the Map object. If the value that is associated to the provided key is an object, then you will get a reference to that object and any change made to that object will effectively modify it inside the Map.

Returns
Returns the element associated with the specified key. If no element is associated with the specified key, undefined is returned.
Parameters
- key: P
Returns undefined | SortDirection
Inherited from Map.get
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:36

has

has(key: P): boolean
Returns
boolean indicating whether an element with the specified key exists or not.
Parameters
- key: P
Returns boolean
Inherited from Map.has
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:40

keys

keys(): IterableIterator
Returns an iterable of keys in the map

Returns IterableIterator
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:131

set

set(key: P, value: SortDirection): Sort
Adds a new element with a specified key and value to the Map. If an element with the same key already exists, the element will be updated.
Parameters
- key: P
- value: SortDirection
Returns Sort
Inherited from Map.set
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:44

values

values(): IterableIterator<SortDirection>
Returns an iterable of values in the map

Returns IterableIterator<SortDirection>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:136

Class Sort<P>

Example

Type Params

Type Parameters

P extends string

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Type Parameters

P extends string

Parameters

Optional entries: null | readonly (readonly [P, SortDirection])[]

Returns Sort<P>

Type Parameters

P extends string

Parameters

Optional iterable: null | Iterable<readonly [P, SortDirection]>

Returns Sort<P>

Properties

Readonly [toStringTag]

Readonly size

Returns

Static Readonly [species]

Methods

[iterator]

Returns IterableIterator<[P, SortDirection]>

clear

Returns void

delete

Returns

Parameters

key: P

Returns boolean

entries

Returns IterableIterator<[P, SortDirection]>

forEach

Parameters

callbackfn: ((value: SortDirection, key: P, map: Map<P, SortDirection>) => void)

Parameters

value: SortDirection

key: P

map: Map<P, SortDirection>

Returns void

Optional thisArg: any

Returns void

get

Returns

Parameters

key: P

Returns undefined | SortDirection

has

Returns

Parameters

key: P

Returns boolean

keys

Returns IterableIterator<P>

set

Parameters

key: P

value: SortDirection

Returns Sort<P>

values

Returns IterableIterator<SortDirection>

Settings

Member Visibility

Theme

`Optional` entries: null | readonly (readonly [P, SortDirection])[]

`Optional` iterable: null | Iterable<readonly [P, SortDirection]>

`Readonly` [toStringTag]

`Readonly` size

`Static` `Readonly` [species]

`Optional` thisArg: any