shelving/schemamodule

DATETIMEconstant

Sugar instance of DateTimeSchema for a required UTC datetime. Equivalent to new DateTimeSchema({}).

NULLABLE_DATETIMEconstant

Sugar instance allowing a DATETIME or null. Equivalent to NULLABLE(DATETIME).

PASSWORDconstant

Sugar instance of PasswordSchema for a password string. Equivalent to new PasswordSchema({}).

SLUGconstant

Sugar instance of SlugSchema for a valid slug. Equivalent to new SlugSchema({}).

NULLABLE_SLUGconstant

Sugar instance allowing a SLUG or null. Equivalent to NULLABLE(SLUG).

STRINGconstant

Sugar instance of StringSchema for an unconstrained string. Equivalent to new StringSchema({}).

REQUIRED_STRINGconstant

Sugar instance of StringSchema requiring at least one character. Equivalent to new StringSchema({ min: 1 }).

TITLEconstant

Sugar instance of StringSchema for a title of 1–100 characters. Equivalent to new StringSchema({ one: "title", title: "Title", min: 1, max: 100 }).

NULLABLE_TITLEconstant

Sugar instance allowing a TITLE or null. Equivalent to NULLABLE(TITLE).

NAMEconstant

Sugar instance of StringSchema for a name of 1–100 characters. Equivalent to new StringSchema({ one: "name", title: "Name", min: 1, max: 100 }).

NULLABLE_NAMEconstant

Sugar instance allowing a NAME or null. Equivalent to NULLABLE(NAME).

CURRENCY_CODEconstant

Sugar instance of CurrencyCodeSchema for a required ISO 4217 currency code, e.g. GBP. Equivalent to new CurrencyCodeSchema({}).

NULLABLE_CURRENCY_CODEconstant

Sugar instance allowing a CURRENCY_CODE or null. Equivalent to NULLABLE(CURRENCY_CODE).

EMAILconstant

Sugar instance of EmailSchema for a valid email address. Equivalent to new EmailSchema({}).

NULLABLE_EMAILconstant

Sugar instance allowing an EMAIL or null. Equivalent to NULLABLE(EMAIL).

COUNTRYconstant

Sugar instance of CountrySchema for a required ISO 3166 country code, e.g. GB. Equivalent to new CountrySchema({}).

NULLABLE_COUNTRYconstant

Sugar instance allowing a COUNTRY or null. Equivalent to NULLABLE(COUNTRY).

PHONEconstant

Sugar instance of PhoneSchema for a valid phone number. Equivalent to new PhoneSchema({}).

NULLABLE_PHONEconstant

Sugar instance allowing a PHONE or null. Equivalent to NULLABLE(PHONE).

USD_AMOUNTconstant

Sugar instance of CurrencyAmountSchema for a US dollar amount. Equivalent to new CurrencyAmountSchema({ currency: "USD" }).

GBP_AMOUNTconstant

Sugar instance of CurrencyAmountSchema for a pound sterling amount. Equivalent to new CurrencyAmountSchema({ currency: "GBP" }).

EUR_AMOUNTconstant

Sugar instance of CurrencyAmountSchema for a euro amount. Equivalent to new CurrencyAmountSchema({ currency: "EUR" }).

NULLABLE_USD_AMOUNTconstant

Sugar instance allowing a USD_AMOUNT or null. Equivalent to NULLABLE(USD_AMOUNT).

NULLABLE_GBP_AMOUNTconstant

Sugar instance allowing a GBP_AMOUNT or null. Equivalent to NULLABLE(GBP_AMOUNT).

NULLABLE_EUR_AMOUNTconstant

Sugar instance allowing an EUR_AMOUNT or null. Equivalent to NULLABLE(EUR_AMOUNT).

UNKNOWNconstant

Unknown validator that always passes through its input value as unknown.

UNKNOWN: Schema<unknown>

UNDEFINEDconstant

Undefined validator that always returns undefined.

UNDEFINED: Schema<undefined>

NULLconstant

Null validator that always returns null.

NULL: Schema<null>

BOOLEANconstant

Sugar instance of BooleanSchema for a coerced boolean. Equivalent to new BooleanSchema({}).

URI_SCHEMAconstant

Sugar instance of URISchema for an absolute URI string. Equivalent to new URISchema({}).

NULLABLE_URI_SCHEMAconstant

Sugar instance allowing a URI_SCHEMA or null. Equivalent to NULLABLE(URI_SCHEMA).

KEYconstant

Sugar instance of KeySchema for a database key. Equivalent to new KeySchema({ title: "ID" }).

NULLABLE_KEYconstant

Sugar instance allowing a KEY or null. Equivalent to NULLABLE(KEY).

NUMBERconstant

Sugar instance of NumberSchema for an unconstrained number. Equivalent to new NumberSchema({ title: "Number" }).

NULLABLE_NUMBERconstant

Sugar instance allowing a NUMBER or null. Equivalent to NULLABLE(NUMBER).

INTEGERconstant

Sugar instance of NumberSchema for an integer. Equivalent to new NumberSchema({ step: 1, min: Number.MIN_SAFE_INTEGER, max: Number.MAX_SAFE_INTEGER }).

POSITIVE_INTEGERconstant

Sugar instance of NumberSchema for a positive integer (excluding zero). Equivalent to new NumberSchema({ step: 1, min: 1, max: Number.MAX_SAFE_INTEGER }).

NON_NEGATIVE_INTEGERconstant

Sugar instance of NumberSchema for a non-negative integer (including zero). Equivalent to new NumberSchema({ step: 1, min: 0, max: Number.MAX_SAFE_INTEGER }).

NEGATIVE_INTEGERconstant

Sugar instance of NumberSchema for a negative integer (excluding zero). Equivalent to new NumberSchema({ step: 1, min: Number.MIN_SAFE_INTEGER, max: -1 }).

NON_POSITIVE_INTEGERconstant

Sugar instance of NumberSchema for a non-positive integer (including zero). Equivalent to new NumberSchema({ step: 1, min: Number.MIN_SAFE_INTEGER, max: 0 }).

NULLABLE_INTEGERconstant

Sugar instance allowing an INTEGER or null. Equivalent to NULLABLE(INTEGER).

TIMESTAMPconstant

Sugar instance of NumberSchema for a Unix timestamp (including milliseconds). Equivalent to new NumberSchema({ title: "Timestamp", step: 1, min: Number.MIN_SAFE_INTEGER, max: Number.MAX_SAFE_INTEGER }).

NULLABLE_TIMESTAMPconstant

Sugar instance — alias of NULLABLE_INTEGER. Equivalent to NULLABLE_INTEGER.

DATEconstant

Sugar instance of DateSchema for a required date. Equivalent to new DateSchema({}).

NULLABLE_DATEconstant

Sugar instance allowing a DATE or null. Equivalent to NULLABLE(DATE).

COLORconstant

Sugar instance of ColorSchema for a required hex color string, e.g. #00CCFF. Equivalent to new ColorSchema({}).

NULLABLE_COLORconstant

Sugar instance allowing a COLOR or null. Equivalent to NULLABLE(COLOR).

FILEconstant

Sugar instance of FileSchema for a file name, e.g. file.txt. Equivalent to new FileSchema({}).

NULLABLE_FILEconstant

Sugar instance allowing a FILE or null. Equivalent to NULLABLE(FILE).

UUIDconstant

Sugar instance of UUIDSchema for any valid UUID (versions 1-5). Equivalent to new UUIDSchema({ title: "ID" }).

NULLABLE_UUIDconstant

Sugar instance allowing a UUID or null. Equivalent to NULLABLE(UUID).

ADDRESSconstant

Sugar instance of AddressSchema for postal address data. Equivalent to new AddressSchema({}).

NULLABLE_ADDRESSconstant

Sugar instance allowing an ADDRESS or null. Equivalent to NULLABLE(ADDRESS).

URL_SCHEMAconstant

Sugar instance of URLSchema for an absolute or relative URL string. Equivalent to new URLSchema({}).

NULLABLE_URL_SCHEMAconstant

Sugar instance allowing a URL_SCHEMA or null. Equivalent to NULLABLE(URL_SCHEMA).

ENTITYconstant

Sugar instance of EntitySchema for an entity string, e.g. challenge:a1b2c3. Equivalent to new EntitySchema({}).

NULLABLE_ENTITYconstant

Sugar instance allowing an ENTITY or null. Equivalent to NULLABLE(ENTITY).

TIMEconstant

Sugar instance of TimeSchema for a required abstract time. Equivalent to new TimeSchema({}).

NULLABLE_TIMEconstant

Sugar instance allowing a TIME or null. Equivalent to NULLABLE(TIME).