Class NumberCheck

Common interface implemented by all check classes.

Hierarchy (View Summary)

ValueCheck
- NumberCheck

Constructors

constructor

new NumberCheck(
    key: string | number,
    data: any,
    options?: TolerantCheckOptions,
): NumberCheck
Parameters
- key: string | number
- data: any
- Optionaloptions: TolerantCheckOptions
Returns NumberCheck
Overrides ValueCheck.constructor
- Defined in checks/number.check.ts:10

Properties

`Protected`valid_type

valid_type: boolean

`Protected` `Optional`value

value?: number

`Protected`key

key: string | number

`Protected`data

data: any

`Protected`has_value

has_value: boolean

`Protected`out

Methods

equals

equals(expected: unknown, options?: EqualityCheckOptions): this
Parameters
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns this
- Defined in checks/number.check.ts:58

integer

integer(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:68

minPrecision

minPrecision(decimalPlaces: number, options?: CheckOptions): this
Parameters
- decimalPlaces: number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:77

positive

positive(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:90

negative

negative(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:99

nonNegative

nonNegative(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:108

roundUp

roundUp(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:117

roundDown

roundDown(options?: CheckOptions): this
Parameters
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:124

greaterThan

greaterThan(value: string | number, options?: CheckOptions): this
Parameters
- value: string | number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:131

lessThan

lessThan(value: string | number, options?: CheckOptions): this
Parameters
- value: string | number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:146

atLeast

atLeast(value: string | number, options?: CheckOptions): this
Parameters
- value: string | number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:161

atMost

atMost(value: string | number, options?: CheckOptions): this
Parameters
- value: string | number
- Optionaloptions: CheckOptions
Returns this
- Defined in checks/number.check.ts:176

inherit

inherit(priors: IResult): this
Parameters
- priors: IResult
Returns this
Inherited from ValueCheck.inherit
- Defined in checks/value.check.ts:25

isTrue

isTrue(
func: (data: any) => boolean | Promise<boolean>,
options?: CheckOptions,
): Promise<NumberCheck>
Parameters
- func: (data: any) => boolean | Promise<boolean>
- Optionaloptions: CheckOptions
Returns Promise<NumberCheck>
Inherited from ValueCheck.isTrue
- Defined in checks/value.check.ts:55

`Protected`errorMessage

errorMessage(err: string, options?: CheckOptions): void
Parameters
- err: string
- Optionaloptions: CheckOptions
Returns void
Inherited from ValueCheck.errorMessage
- Defined in checks/value.check.ts:66

`Protected`normalizeEqualityValues

normalizeEqualityValues(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): { actual: unknown; expected: unknown }
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns { actual: unknown; expected: unknown }
Inherited from ValueCheck.normalizeEqualityValues
- Defined in checks/value.check.ts:70

`Protected`equalityMatches

equalityMatches(
    actual: unknown,
    expected: unknown,
    options?: EqualityCheckOptions,
): boolean
Parameters
- actual: unknown
- expected: unknown
- Optionaloptions: EqualityCheckOptions
Returns boolean
Inherited from ValueCheck.equalityMatches
- Defined in checks/value.check.ts:89

`Protected`rules

rules(field_checks: (Check | Promise<Check>)[]): Promise<NumberCheck>
Parameters
- field_checks: (Check | Promise<Check>)[]
Returns Promise<NumberCheck>
Inherited from ValueCheck.rules
- Defined in checks/value.check.ts:97

`Protected`composeAlternatives

composeAlternatives(
mode: "anyOf" | "oneOf",
branches: ((checker: this) => (Check | Promise<Check>)[])[],
): Promise<NumberCheck>
Parameters
- mode: "anyOf" | "oneOf"
- branches: ((checker: this) => (Check | Promise<Check>)[])[]
Returns Promise<NumberCheck>
Inherited from ValueCheck.composeAlternatives
- Defined in checks/value.check.ts:117

not

not(
func: (checker: this) => (Check | Promise<Check>)[],
options?: CheckOptions,
): Promise<NumberCheck>
Parameters
- func: (checker: this) => (Check | Promise<Check>)[]
- Optionaloptions: CheckOptions
Returns Promise<NumberCheck>
Inherited from ValueCheck.not
- Defined in checks/value.check.ts:169

`Protected`createAlternativeChecker

createAlternativeChecker(): this
Returns this
Inherited from ValueCheck.createAlternativeChecker
- Defined in checks/value.check.ts:183

`Protected`cloneAlternativeValue

cloneAlternativeValue<T>(value: T): T
Type Parameters
- T
Parameters
- value: T
Returns T
Inherited from ValueCheck.cloneAlternativeValue
- Defined in checks/value.check.ts:188

`Protected`mergeBranchResult

mergeBranchResult(result: IResult): void
Parameters
- result: IResult
Returns void
Inherited from ValueCheck.mergeBranchResult
- Defined in checks/value.check.ts:208

`Protected`mergeMessageValue

mergeMessageValue(
current?: string | string[],
incoming?: string | string[],
): string | string[] | undefined
Parameters
- Optionalcurrent: string | string[]
- Optionalincoming: string | string[]
Returns string | string[] | undefined
Inherited from ValueCheck.mergeMessageValue
- Defined in checks/value.check.ts:236

`Protected`toArray

toArray(value?: string | string[]): string[]
Parameters
- Optionalvalue: string | string[]
Returns string[]
Inherited from ValueCheck.toArray
- Defined in checks/value.check.ts:250

result

result(options?: ResultOptions): IResult
Builds the validation result for the current check.
Parameters
- Optionaloptions: ResultOptions
Returns IResult
Inherited from ValueCheck.result
- Defined in checks/value.check.ts:258