Skip to content

NumberSchema

  • Methods<Native.Number, NumberSchema>

readonly is: (input) => input is number

unknown

input is number

Methods.is


readonly parse: (input) => Effect<number, ParseError, never>

Checks input and returns it typed, with defaults filled in and unknown object keys removed.

unknown

Effect<number, ParseError, never>

const config = yield* Config.parse(JSON.parse(text));

Methods.parse


readonly schema: Number

The Effect schema underneath, for use with effect/Schema.

Methods.schema

default(value): Field<withDecodingDefaultType<Number, never>>

Uses value when the input is undefined or an object leaves the key out.

number

Field<withDecodingDefaultType<Number, never>>

Methods.default


int(message?): NumberSchema

string

NumberSchema


max(value, message?): NumberSchema

number

string

NumberSchema


min(value, message?): NumberSchema

number

string

NumberSchema


nullable(): Schema<NullOr<Number>>

Schema<NullOr<Number>>

Methods.nullable


optional(): Field<optional<Number>>

Allows undefined, and lets an object leave the key out.

Field<optional<Number>>

Methods.optional


refine(predicate, message?): NumberSchema

(value) => boolean

string

NumberSchema

Methods.refine