• Creates a Array schema.

    Type Parameters

    Parameters

    • Optional elementSchema: TElementSchema

    Returns ArraySchemaBuilder<TElementSchema, true, undefined, TElementSchema extends undefined
        ? any[]
        : TElementSchema extends SchemaBuilder<T1, T2>
            ? (T2 extends true
                ? T1
                : undefined | T1)[]
            : never>

    Example

     const schema = array().minLength(2).maxLength(5).of(string());
    // [] - invalid
    // ['a', 'b'] - valid
    // ['a', 'b', 'c', 'd', 'e', 'f'] - invalid
    // ['a', 'b', 'c', 'd', 'e'] - valid
    // ['a', 'b', 'c', 'd', 1] - invalid
    // ['a', 'b', null] - invalid
    // null - invalid
    // undefined - invalid

Generated using TypeDoc