@sapphire/shapeshift

Enumerations

ObjectValidatorStrategy

Classes

Interfaces

Type aliases

ArrayConstraintName

Ƭ ArrayConstraintName: `s.array(T).length${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual" | "Range" | "RangeInclusive" | "RangeExclusive"}`

Defined in

projects/shapeshift/src/constraints/ArrayLengthConstraints.ts:6

BigIntConstraintName

Ƭ BigIntConstraintName: `s.bigint.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "notEqual" | "divisibleBy"}`

Defined in

projects/shapeshift/src/constraints/BigIntConstraints.ts:6

BooleanConstraintName

Ƭ BooleanConstraintName: `s.boolean.${boolean}`

Defined in

projects/shapeshift/src/constraints/BooleanConstraints.ts:5

ConstraintErrorNames

Defined in

projects/shapeshift/src/lib/errors/BaseConstraintError.ts:12

Constructor

Ƭ Constructor<T>: (...args: readonly any[]) => T | (...args: readonly any[]) => T

Type parameters

Name
`T`

Defined in

projects/shapeshift/src/lib/util-types.ts:3

DateConstraintName

Ƭ DateConstraintName: `s.date.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "notEqual" | "valid" | "invalid"}`

Defined in

projects/shapeshift/src/constraints/DateConstraints.ts:6

ExpandSmallerTuples

Ƭ ExpandSmallerTuples<T>: T extends [T[0], ...infer Tail] ? T | ExpandSmallerTuples<Tail> : []

Type parameters

Name	Type
`T`	extends [...any[]]

Defined in

projects/shapeshift/src/validators/ArrayValidator.ts:97

GrowExp

Ƭ GrowExp<A, N, P>: [...A, ...A][`N`] extends undefined ? GrowExp<[...A, ...A], N, [A, ...P]> : GrowExpRev<A, N, P>

Type parameters

Name	Type
`A`	extends `any`[]
`N`	extends `number`
`P`	extends `any`[][]

Defined in

projects/shapeshift/src/validators/ArrayValidator.ts:106

GrowExpRev

Ƭ GrowExpRev<A, N, P>: A["length"] extends N ? A : GrowExpRev<[...A, ...P[0]][`N`] extends undefined ? [...A, ...P[0]] : A, N, Shift<P>>

Type parameters

Name	Type
`A`	extends `any`[]
`N`	extends `number`
`P`	extends `any`[][]

Defined in

projects/shapeshift/src/validators/ArrayValidator.ts:102

InferType

Ƭ InferType<T>: T extends ObjectValidator<infer U> ? U : never

Infers the type of a schema object given typeof schema. The schema has to extend ObjectValidator.

example

import { InferType, s } from '@sapphire/shapeshift';

const schema = s.object({
    foo: s.string,
    bar: s.number,
    baz: s.boolean,
    qux: s.bigint,
    quux: s.date
});

type Inferredtype = InferType<typeof schema>;
// Expected type:
// type Inferredtype = {
//  foo: string;
//  bar: number;
//  baz: boolean;
//  qux: bigint;
//  quux: Date;
// };

Type parameters

Name	Type
`T`	extends `ObjectValidator`<`any`>

Defined in

projects/shapeshift/src/utility-types.ts:84

MappedObjectValidator

Ƭ MappedObjectValidator<T>: { [key in keyof T]: BaseValidator<T[key]> }

Type parameters

Name
`T`

Defined in

projects/shapeshift/src/lib/util-types.ts:10

NonNullObject

Ƭ NonNullObject: {} & object

Defined in

projects/shapeshift/src/lib/util-types.ts:8

NumberConstraintName

Ƭ NumberConstraintName: `s.number.${"lessThan" | "lessThanOrEqual" | "greaterThan" | "greaterThanOrEqual" | "equal" | "equal(NaN)" | "notEqual" | "notEqual(NaN)" | "int" | "safeInt" | "finite" | "divisibleBy"}`

Defined in

projects/shapeshift/src/constraints/NumberConstraints.ts:6

SchemaOf

Ƭ SchemaOf<T>: ObjectValidator<T>

An alias of ObjectValidator with a name more common among object validation libraries. This is the type of a schema after using s.object({ ... })

example

import { s, SchemaOf } from '@sapphire/shapeshift';

interface IIngredient {
    ingredientId: string | undefined;
    name: string | undefined;
}

interface IInstruction {
    instructionId: string | undefined;
    message: string | undefined;
}

interface IRecipe {
    recipeId: string | undefined;
    title: string;
    description: string;
    instructions: IInstruction[];
    ingredients: IIngredient[];
}

type InstructionSchemaType = SchemaOf<IInstruction>;
// Expected Type: ObjectValidator<IInstruction>

type IngredientSchemaType = SchemaOf<IIngredient>;
// Expected Type: ObjectValidator<IIngredient>

type RecipeSchemaType = SchemaOf<IRecipe>;
// Expected Type: ObjectValidator<IRecipe>

const instructionSchema: InstructionSchemaType = s.object({
    instructionId: s.string.optional,
    message: s.string
});

const ingredientSchema: IngredientSchemaType = s.object({
    ingredientId: s.string.optional,
    name: s.string
});

const recipeSchema: RecipeSchemaType = s.object({
    recipeId: s.string.optional,
    title: s.string,
    description: s.string,
    instructions: s.array(instructionSchema),
    ingredients: s.array(ingredientSchema)
});

Type parameters

Name
`T`

Defined in

projects/shapeshift/src/utility-types.ts:56

Shift

Ƭ Shift<A>: (...args: A) => void extends (...args: [A[0], ...infer R]) => void ? R : never

Type parameters

Name	Type
`A`	extends `any`[]

Defined in

projects/shapeshift/src/validators/ArrayValidator.ts:100

StringConstraintName

Ƭ StringConstraintName: `s.string.${`length${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual"}` | "regex" | "url" | "uuid" | "email" | `ip${"v4" | "v6" | ""}` | "date"}`

Defined in

projects/shapeshift/src/constraints/StringConstraints.ts:9

StringDomain

Ƭ StringDomain: `${string}.${string}`

Defined in

projects/shapeshift/src/constraints/StringConstraints.ts:21

StringProtocol

Ƭ StringProtocol: `${string}:`

Defined in

projects/shapeshift/src/constraints/StringConstraints.ts:19

Tuple

Ƭ Tuple<T, N>: number extends N ? T[] : N extends 0 ? [] : N extends 1 ? [T] : GrowExp<[T], N, [[]]>

Type parameters

Name	Type
`T`	`T`
`N`	extends `number`

Defined in

projects/shapeshift/src/validators/ArrayValidator.ts:110

Type

Ƭ Type<V>: V extends BaseValidator<infer T> ? T : never

Type parameters

Name
`V`

Defined in

projects/shapeshift/src/lib/util-types.ts:5

TypedArrayConstraintName

Ƭ TypedArrayConstraintName: `s.typedArray(T).${"byteLength" | "length"}${"LessThan" | "LessThanOrEqual" | "GreaterThan" | "GreaterThanOrEqual" | "Equal" | "NotEqual" | "Range" | "RangeInclusive" | "RangeExclusive"}`