Class Modes

Modes represents the terminal modes that can be set or reset. By default, all modes are ModeSetting.NOT_RECOGNIZED.

Hierarchy

Map<Mode, ModeSetting>
- Modes

Index

Constructors

constructor

new Modes(entries?: null | readonly (readonly [Mode, ModeSetting])[]): Modes
Parameters
- Optionalentries: null | readonly (readonly [Mode, ModeSetting])[]
Returns Modes
Inherited from Map<Mode, ModeSetting>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50
new Modes(
iterable?: null | Iterable<readonly [Mode, ModeSetting], any, any>,
): Modes
Parameters
- Optionaliterable: null | Iterable<readonly [Mode, ModeSetting], any, any>
Returns Modes
Inherited from Map<Mode, ModeSetting>.constructor
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:49
- Defined in node_modules/typescript/lib/lib.es2015.collection.d.ts:50

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]"(): MapIterator<[Mode, ModeSetting]>
Returns an iterable of entries in the map.

Returns MapIterator<[Mode, ModeSetting]>
Inherited from Map.[iterator]
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:143

clear

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

delete

delete(mode: Mode): boolean
Delete deletes a terminal mode. This has the same effect as setting the mode to ModeSetting.NOT_RECOGNIZED.
Parameters
- mode: Mode
Returns boolean
Overrides Map.delete
- Defined in src/modes.ts:22

entries

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

Returns MapIterator<[Mode, ModeSetting]>
Inherited from Map.entries
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:148

forEach

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

get

get(mode: Mode): ModeSetting
Get returns the setting of a terminal mode. If the mode is not set, it returns ModeSetting.NOT_RECOGNIZED.
Parameters
- mode: Mode
Returns ModeSetting
Overrides Map.get
- Defined in src/modes.ts:14

has

has(key: Mode): boolean
Parameters
- key: Mode
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

isPermanentlyReset

isPermanentlyReset(mode: Mode): boolean
Is Permanently Reset returns true if the mode is set to ModeSetting.PERMANENTLY_RESET.
Parameters
- mode: Mode
Returns boolean
- Defined in src/modes.ts:78

isPermanentlySet

isPermanentlySet(mode: Mode): boolean
Is Permanently Set returns true if the mode is set to ModeSetting.PERMANENTLY_SET.
Parameters
- mode: Mode
Returns boolean
- Defined in src/modes.ts:64

isReset

isReset(mode: Mode): boolean
Is Reset returns true if the mode is set to ModeSetting.RESET or ModeSetting.PERMANENTLY_RESET.
Parameters
- mode: Mode
Returns boolean
- Defined in src/modes.ts:71

isSet

isSet(mode: Mode): boolean
Is Set returns true if the mode is set to ModeSetting.SET or ModeSetting.PERMANENTLY_SET.
Parameters
- mode: Mode
Returns boolean
- Defined in src/modes.ts:57

keys

keys(): MapIterator<Mode>
Returns an iterable of keys in the map

Returns MapIterator<Mode>
Inherited from Map.keys
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:153

permanentlyReset

permanentlyReset(mode: Mode): Modes
Permanently Reset sets a terminal mode to ModeSetting.PERMANENTLY_RESET.
Parameters
- mode: Mode
Returns Modes
- Defined in src/modes.ts:50

permanentlySet

permanentlySet(mode: Mode): Modes
Permanently Set sets a terminal mode to ModeSetting.PERMANENTLY_SET.
Parameters
- mode: Mode
Returns Modes
- Defined in src/modes.ts:36

reset

reset(mode: Mode): Modes
Reset sets a terminal mode to ModeSetting.RESET.
Parameters
- mode: Mode
Returns Modes
- Defined in src/modes.ts:43

set

set(mode: Mode): Modes
Set sets a terminal mode to ModeSetting.SET.
Parameters
- mode: Mode
Returns Modes
Overrides Map.set
- Defined in src/modes.ts:29

values

values(): MapIterator<ModeSetting>
Returns an iterable of values in the map

Returns MapIterator<ModeSetting>
Inherited from Map.values
- Defined in node_modules/typescript/lib/lib.es2015.iterable.d.ts:158

`Static`groupBy

groupBy<K, T>(
items: Iterable<T>,
keySelector: (item: T, index: number) => K,
): Map<K, T[]>
Groups members of an iterable according to the return value of the passed callback.
Type Parameters
- K
- T
Parameters
- items: Iterable<T>
  An iterable.
- keySelector: (item: T, index: number) => K
  A callback which will be invoked for each item in items.
Returns Map<K, T[]>
Inherited from Map.groupBy
- Defined in node_modules/typescript/lib/lib.es2024.collection.d.ts:25

Class Modes

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns Modes

Parameters

Returns Modes

Properties

Readonly[toStringTag]

Readonlysize

Returns

Static Readonly[species]

Methods

[iterator]

Returns MapIterator<[Mode, ModeSetting]>

clear

Returns void

delete

Parameters

Returns boolean

entries

Returns MapIterator<[Mode, ModeSetting]>

forEach

Parameters

Returns void

get

Parameters

Returns ModeSetting

has

Parameters

Returns boolean

isPermanentlyReset

Parameters

Returns boolean

isPermanentlySet

Parameters

Returns boolean

isReset

Parameters

Returns boolean

isSet

Parameters

Returns boolean

keys

Returns MapIterator<Mode>

permanentlyReset

Parameters

Returns Modes

permanentlySet

Parameters

Returns Modes

reset

Parameters

Returns Modes

set

Parameters

Returns Modes

values

Returns MapIterator<ModeSetting>

StaticgroupBy

Type Parameters

Parameters

Returns Map<K, T[]>

Settings

On This Page

`Readonly`[toStringTag]

`Readonly`size

`Static` `Readonly`[species]

`Static`groupBy