Class Options<T>

Improve Map by adding a merge feature and optional compile-time key/value typing.

Type Parameters

T extends OptionsObject = OptionsObject
Shape of the options object. When omitted the class behaves like the original untyped Options.

Hierarchy

Map
- Options

Index

Constructors

Properties

size [toStringTag] [species]

Methods

clear delete forEach has [iterator] entries keys values merge get set

Constructors

constructor

new Options<T>(o?): Options<T>
Type Parameters
- T extends OptionsObject = OptionsObject
Parameters
- Optional o: OptionsObject | Options<any>
Returns Options<T>
Overrides Map.constructor
- Defined in src/utils/options.ts:14

Properties

`Readonly` size

size: number

Returns

the number of elements in the Map.

`Readonly` [toStringTag]

[toStringTag]: string

`Static` `Readonly` [species]

[species]: MapConstructor

Methods

clear

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

delete

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

forEach

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

has

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

[iterator]

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

Returns IterableIterator<[any, any]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:119

entries

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

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

keys

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

Returns IterableIterator<any>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:129

values

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

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

merge

merge(o?): Options<T>
Merge provided Options or object into current Options without altering current instance
Parameters
- Optional o: OptionsObject | Options<any>
Returns Options<T>
a new Options object
- Defined in src/utils/options.ts:27

get

get<K>(key): T[K]
Retrieve a typed value by key.
Type Parameters
- K extends string
Parameters
- key: K
Returns T[K]
Overrides Map.get
- Defined in src/utils/options.ts:40

set

set<K>(key, value): this
Store a typed value by key.
Type Parameters
- K extends string
Parameters
- key: K
- value: T[K]
Returns this
Overrides Map.set
- Defined in src/utils/options.ts:47