Class Asserts

Hierarchy

Asserts

Index

Constructors

Properties

_assets _mustStop

Accessors

Constructors

constructor

new Asserts(): Asserts
Returns Asserts

Properties

`Private` _assets

_assets: Map<string, Assert> = ...

`Private` _mustStop

_mustStop: boolean = false

Accessors

length

get length(): number
Returns number
- Defined in src/asserts.ts:7

Methods

[iterator]

[iterator](): IterableIterator<[string, Assert]>
Returns IterableIterator<[string, Assert]>
- Defined in src/asserts.ts:170

add

add(assert: Assert): void
Parameters
- assert: Assert
Returns void
- Defined in src/asserts.ts:133

byStatus

byStatus(status: Status): Map<string, Assert>
Parameters
- status: Status
Returns Map<string, Assert>
- Defined in src/asserts.ts:100

entries

entries(): IterableIterator<[string, Assert]>
Returns IterableIterator<[string, Assert]>
- Defined in src/asserts.ts:174

errors

errors(): Map<string, Assert>
Returns Map<string, Assert>
- Defined in src/asserts.ts:121

exists

exists(code: string): boolean
Parameters
- code: string
Returns boolean
- Defined in src/asserts.ts:113

get

get(code: string): Assert
Parameters
- code: string
Returns Assert
- Defined in src/asserts.ts:104

getFirstStatus

getFirstStatus(status: Status): undefined | Assert
Parameters
- status: Status
Returns undefined | Assert
- Defined in src/asserts.ts:90

hasErrors

hasErrors(): boolean
Returns boolean
- Defined in src/asserts.ts:82

hasStatus

hasStatus(status: Status): boolean
Parameters
- status: Status
Returns boolean
- Defined in src/asserts.ts:78

hasWarnings

hasWarnings(): boolean
Returns boolean
- Defined in src/asserts.ts:86

import

import(asserts: Asserts): void
Parameters
- asserts: Asserts
Returns void
- Defined in src/asserts.ts:162

`Private` indexOf

indexOf(assert: Assert): string
Parameters
- assert: Assert
Returns string
- Defined in src/asserts.ts:137

keys

keys(): IterableIterator<string>
Returns IterableIterator<string>
- Defined in src/asserts.ts:178

mustStop

mustStop(newValue?: null | boolean): boolean
Get and or set the flag that alerts about stop flow Consider this flag as: "Something was found, you should not continue"

Returns
the previous value of the flag
Parameters
- newValue: null | boolean = null
  
  Value of the flag, if null then will not change the flag
Returns boolean
- Defined in src/asserts.ts:68

nones

nones(): Map<string, Assert>
Returns Map<string, Assert>
- Defined in src/asserts.ts:129

oks

oks(): Map<string, Assert>
Returns Map<string, Assert>
- Defined in src/asserts.ts:117

put

put(code: string, title?: null | string, status?: null | Status, explanation?: null | string): Assert
This will try to create a new assert or get and change assert with the same code The new values are preserved, except if they are null
Parameters
- code: string
- title: null | string = null
- status: null | Status = null
- explanation: null | string = null
Returns Assert
- Defined in src/asserts.ts:22

putStatus

putStatus(code: string, status?: null | Status, explanation?: null | string): Assert
This will try to create a new assert or get and change assert with the same code The new values are preserved, except if they are null
Parameters
- code: string
- status: null | Status = null
- explanation: null | string = null
Returns Assert
- Defined in src/asserts.ts:57

remove

remove(assert: Assert): void
Parameters
- assert: Assert
Returns void
- Defined in src/asserts.ts:147

removeAll

removeAll(): void
Returns void
- Defined in src/asserts.ts:158

removeByCode

removeByCode(code: string): void
Parameters
- code: string
Returns void
- Defined in src/asserts.ts:154

values

values(): IterableIterator<Assert>
Returns IterableIterator<Assert>
- Defined in src/asserts.ts:182

warnings

warnings(): Map<string, Assert>
Returns Map<string, Assert>
- Defined in src/asserts.ts:125

Generated using TypeDoc