Class Status

The Status class manages the status of anything that can have a 4-state status: idle, pending, success, error.

Aracna Reference

Index

Constructors

Properties

data transformer

Accessors

ERROR IDLE PENDING SUCCESS

Methods

areSomeError areSomeIdle areSomePending areSomeSuccess clear error get idle isError isEveryError isEveryIdle isEveryPending isEverySuccess isIdle isPending isSuccess pending set success

Constructors

constructor

new Status(transformer?: StatusTransformer): Status
Parameters
- transformer: StatusTransformer = DEFAULT_STATUS_TRANSFORMER
Returns Status
- Defined in src/classes/status.ts:20

Properties

`Readonly`data

data: Map<string, string>

The Map that stores the status of each key.

`Readonly`transformer

transformer: StatusTransformer

The function that transforms the keys before storing them in the Map.

Accessors

`Static`ERROR

get ERROR(): string
Returns string
- Defined in src/classes/status.ts:172

`Static`IDLE

get IDLE(): string
Returns string
- Defined in src/classes/status.ts:160

`Static`PENDING

get PENDING(): string
Returns string
- Defined in src/classes/status.ts:164

`Static`SUCCESS

get SUCCESS(): string
Returns string
- Defined in src/classes/status.ts:168

Methods

areSomeError

areSomeError(...keys: string[][]): boolean
Checks if the status of some given key is error.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:156

areSomeIdle

areSomeIdle(...keys: string[][]): boolean
Checks if the status of some given key is idle.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:135

areSomePending

areSomePending(...keys: string[][]): boolean
Checks if the status of some given key is pending.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:142

areSomeSuccess

areSomeSuccess(...keys: string[][]): boolean
Checks if the status of some given key is success.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:149

clear

clear(): void
Clears the status of every key.

Returns void
- Defined in src/classes/status.ts:71

error

error(...keys: string[]): void
Sets the status of the given keys to error.
Parameters
- ...keys: string[]
Returns void
- Defined in src/classes/status.ts:56

get

get(...keys: string[]): string
Retrieves the status of the given keys.
Parameters
- ...keys: string[]
Returns string
- Defined in src/classes/status.ts:28

idle

idle(...keys: string[]): void
Sets the status of the given keys to idle.
Parameters
- ...keys: string[]
Returns void
- Defined in src/classes/status.ts:35

isError

isError(...keys: string[]): boolean
Checks if the status of the given keys is error.
Parameters
- ...keys: string[]
Returns boolean
- Defined in src/classes/status.ts:100

isEveryError

isEveryError(...keys: string[][]): boolean
Checks if the status of every given key is error.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:128

isEveryIdle

isEveryIdle(...keys: string[][]): boolean
Checks if the status of every given key is idle.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:107

isEveryPending

isEveryPending(...keys: string[][]): boolean
Checks if the status of every given key is pending.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:114

isEverySuccess

isEverySuccess(...keys: string[][]): boolean
Checks if the status of every given key is success.
Parameters
- ...keys: string[][]
Returns boolean
- Defined in src/classes/status.ts:121

isIdle

isIdle(...keys: string[]): boolean
Checks if the status of the given keys is idle.
Parameters
- ...keys: string[]
Returns boolean
- Defined in src/classes/status.ts:79

isPending

isPending(...keys: string[]): boolean
Checks if the status of the given keys is pending.
Parameters
- ...keys: string[]
Returns boolean
- Defined in src/classes/status.ts:86

isSuccess

isSuccess(...keys: string[]): boolean
Checks if the status of the given keys is success.
Parameters
- ...keys: string[]
Returns boolean
- Defined in src/classes/status.ts:93

pending

pending(...keys: string[]): void
Sets the status of the given keys to pending.
Parameters
- ...keys: string[]
Returns void
- Defined in src/classes/status.ts:42

set

set(keys: string[], status: string): void
Sets the status of the given keys to the given status.
Parameters
- keys: string[]
- status: string
Returns void
- Defined in src/classes/status.ts:63

success

success(...keys: string[]): void
Sets the status of the given keys to success.
Parameters
- ...keys: string[]
Returns void
- Defined in src/classes/status.ts:49