Function group

group<Conditional extends GroupConditional<any, any, any, any>>(
conditionals: Conditional[],
): ObjectGroup<Conditional>
Create an object group. Groups are used to conditionally merge properties to an existing object.
Type Parameters
- Conditional extends GroupConditional<any, any, any, any>
Parameters
- conditionals: Conditional[]
Returns ObjectGroup<Conditional>
- Defined in src/schema/object/group_builder.ts:20

Index

Methods

Methods

if

if<Properties extends Record<string, SchemaTypes>>(
    conditon: (value: Record<string, unknown>, field: FieldContext) => any,
    properties: Properties,
): GroupConditional<
    Properties,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof ITYPE] },
    >,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof OTYPE] },
    >,
    UndefinedOptional<
        {
            [K in string
            | number
            | symbol as CamelCase<K & string>]: Properties[K][typeof COTYPE]
        },
    >,
>
Wrap object properties inside a conditonal
Type Parameters
- Properties extends Record<string, SchemaTypes>
Parameters
- conditon: (value: Record<string, unknown>, field: FieldContext) => any
- properties: Properties
Returns GroupConditional<
    Properties,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof ITYPE] },
    >,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof OTYPE] },
    >,
    UndefinedOptional<
        {
            [K in string
            | number
            | symbol as CamelCase<K & string>]: Properties[K][typeof COTYPE]
        },
    >,
>
- Defined in src/schema/object/group_builder.ts:29

else

else<Properties extends Record<string, SchemaTypes>>(
    properties: Properties,
): GroupConditional<
    Properties,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof ITYPE] },
    >,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof OTYPE] },
    >,
    UndefinedOptional<
        {
            [K in string
            | number
            | symbol as CamelCase<K & string>]: Properties[K][typeof COTYPE]
        },
    >,
>
Wrap object properties inside an else conditon
Type Parameters
- Properties extends Record<string, SchemaTypes>
Parameters
- properties: Properties
Returns GroupConditional<
    Properties,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof ITYPE] },
    >,
    UndefinedOptional<
        { [K in string
        | number
        | symbol]: Properties[K][typeof OTYPE] },
    >,
    UndefinedOptional<
        {
            [K in string
            | number
            | symbol as CamelCase<K & string>]: Properties[K][typeof COTYPE]
        },
    >,
>
- Defined in src/schema/object/group_builder.ts:50