schemaGuards
constschemaGuards:object
Collection of type guards for all schema types.
Type Declaration
isString(): (s) => s is Schema<string> & { type: "string" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<string> & { type: "string" } & Schema<any> & { type: SchemaType }
isNumber(): (s) => s is Schema<number> & { type: "number" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<number> & { type: "number" } & Schema<any> & { type: SchemaType }
isBoolean(): (s) => s is Schema<boolean> & { type: "boolean" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<boolean> & { type: "boolean" } & Schema<any> & { type: SchemaType }
isDate(): (s) => s is Schema<Date> & { type: "date" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Date> & { type: "date" } & Schema<any> & { type: SchemaType }
isBigInt(): (s) => s is Schema<bigint> & { type: "bigint" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<bigint> & { type: "bigint" } & Schema<any> & { type: SchemaType }
isSymbol(): (s) => s is Schema<symbol> & { type: "symbol" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<symbol> & { type: "symbol" } & Schema<any> & { type: SchemaType }
isInt(): (s) => s is Schema<number> & { type: "int" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<number> & { type: "int" } & Schema<any> & { type: SchemaType }
isEnum(): (s) => s is Schema<string | number | boolean> & { type: "enum"; enumValues: readonly (string | number | boolean)[] } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<string | number | boolean> & { type: "enum"; enumValues: readonly (string | number | boolean)[] } & Schema<any> & { type: SchemaType }
isLiteral(): (s) => s is Schema<string | number | boolean> & { type: "literal"; literalValue: string | number | boolean } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<string | number | boolean> & { type: "literal"; literalValue: string | number | boolean } & Schema<any> & { type: SchemaType }
isNativeEnum(): (s) => s is Schema<string | number> & { type: "nativeEnum"; enumValues: readonly (string | number)[]; enumObj: E } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<string | number> & { type: "nativeEnum"; enumValues: readonly (string | number)[]; enumObj: E } & Schema<any> & { type: SchemaType }
isAny(): (s) => s is Schema<any> & { type: "any" } & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "any" } & { type: SchemaType }
isUnknown(): (s) => s is Schema<unknown> & { type: "unknown" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<unknown> & { type: "unknown" } & Schema<any> & { type: SchemaType }
isNever(): (s) => s is Schema<never> & { type: "never" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<never> & { type: "never" } & Schema<any> & { type: SchemaType }
isNull(): (s) => s is Schema<null> & { type: "null" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<null> & { type: "null" } & Schema<any> & { type: SchemaType }
isUndefined(): (s) => s is Schema<undefined> & { type: "undefined" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<undefined> & { type: "undefined" } & Schema<any> & { type: SchemaType }
isVoid(): (s) => s is Schema<void> & { type: "void" } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<void> & { type: "void" } & Schema<any> & { type: SchemaType }
isArray(): (s) => s is Schema<any[]> & { type: "array"; itemSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any[]> & { type: "array"; itemSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isObject(): (s) => s is Schema<{ [key: string]: any }> & { type: "object"; entries: T } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<{ [key: string]: any }> & { type: "object"; entries: T } & Schema<any> & { type: SchemaType }
isTuple(): (s) => s is Schema<readonly any[]> & { type: "tuple"; items: readonly GenericSchema[] } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<readonly any[]> & { type: "tuple"; items: readonly GenericSchema[] } & Schema<any> & { type: SchemaType }
isRecord(): (s) => s is Schema<Record<any, any>> & { type: "record"; keySchema: GenericSchema; valueSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Record<any, any>> & { type: "record"; keySchema: GenericSchema; valueSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isMap(): (s) => s is Schema<Map<any, any>> & { type: "map"; keySchema: GenericSchema; valueSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Map<any, any>> & { type: "map"; keySchema: GenericSchema; valueSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isSet(): (s) => s is Schema<Set<any>> & { type: "set"; itemSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Set<any>> & { type: "set"; itemSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isUnion(): (s) => s is Schema<any> & { type: "union"; schemas: readonly GenericSchema[] } & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "union"; schemas: readonly GenericSchema[] } & { type: SchemaType }
isIntersection(): (s) => s is Schema<any> & { type: "intersection"; schemas: readonly GenericSchema[] } & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "intersection"; schemas: readonly GenericSchema[] } & { type: SchemaType }
isKeyof(): (s) => s is Schema<string> & { type: "keyof"; objectSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<string> & { type: "keyof"; objectSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isPartial(): (s) => s is Schema<Partial<any>> & { type: "partial"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Partial<any>> & { type: "partial"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isRequired(): (s) => s is Schema<Required<any>> & { type: "required"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Required<any>> & { type: "required"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isPick(): (s) => s is Schema<Pick<any, string>> & { type: "pick"; innerSchema: GenericSchema; keys: readonly string[] } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Pick<any, string>> & { type: "pick"; innerSchema: GenericSchema; keys: readonly string[] } & Schema<any> & { type: SchemaType }
isOmit(): (s) => s is Schema<Omit<any, string>> & { type: "omit"; innerSchema: GenericSchema; keys: readonly string[] } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Omit<any, string>> & { type: "omit"; innerSchema: GenericSchema; keys: readonly string[] } & Schema<any> & { type: SchemaType }
isNullable(): (s) => s is Schema<any> & { type: "nullable"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "nullable"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isNullish(): (s) => s is Schema<any> & { type: "nullish"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "nullish"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isOptional(): (s) => s is Schema<any> & { type: "optional"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "optional"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isDefault(): (s) => s is Schema<any> & { type: "default"; innerSchema: GenericSchema; defaultValue: any } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<any> & { type: "default"; innerSchema: GenericSchema; defaultValue: any } & Schema<any> & { type: SchemaType }
isReadonly(): (s) => s is Schema<Readonly<any>> & { type: "readonly"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<Readonly<any>> & { type: "readonly"; innerSchema: GenericSchema } & Schema<any> & { type: SchemaType }
isLazy(): (s) => s is Schema<unknown> & { type: "lazy"; getter: () => Schema<unknown> } & Schema<any> & { type: SchemaType }
s:
GenericSchema
Returns:s is Schema<unknown> & { type: "lazy"; getter: () => Schema<unknown> } & Schema<any> & { type: SchemaType }
Since
2.0.0