Natural overview

Table of contents

• arbitrary
  • arbitrary
• model
  • Natural (type alias)
• predicates
  • isNatural
• schemas
  • Natural

arbitrary

arbitrary

FastCheck arbitrary for generating random Natural instances.

Signature

export declare const arbitrary: FastCheck.Arbitrary<number>

Added in v2.0.0

model

Natural (type alias)

Type alias for Natural representing positive integers.

Signature

export type Natural = typeof Natural.Type

Added in v2.0.0

predicates

isNatural

Check if the given value is a valid Natural

Signature

export declare const isNatural: (u: unknown, overrideOptions?: ParseOptions | number) => u is number

Added in v2.0.0

schemas

Natural

Natural number schema for positive integers. Used for validating non-negative integers greater than 0.

Signature

export declare const Natural: Schema.refine<number, typeof Schema.Number>

Added in v2.0.0