Type Alias NestedValidationResult<TSchema, TRootSchema, TParentPropertyDescriptor>

Used to represent a validation result for nested objects/properties. Contains a list of errors and the value that caused them.

type NestedValidationResult<
    TSchema,
    TRootSchema extends ObjectSchemaBuilder<any, any, any, any, any>,
    TParentPropertyDescriptor,
> = {
    errors: ReadonlyArray<string>;
    isValid: boolean;
    seenValue?: InferType<TSchema>;
    get descriptor(): PropertyDescriptorInner<
        TRootSchema,
        TSchema,
        TParentPropertyDescriptor,
    >;
}

Type Parameters

TSchema
TRootSchema extends ObjectSchemaBuilder<any, any, any, any, any>
TParentPropertyDescriptor

Index

Properties

errors isValid seenValue?

Accessors

Properties

errors

errors: ReadonlyArray<string>

A list of errors, empty if object satisfies a schema

isValid

isValid: boolean

Whether validation passed for this property and all of its children.

`Optional`seenValue

seenValue?: InferType<TSchema>

Value that property had and which caused error or errors

Accessors

descriptor

get descriptor(): PropertyDescriptorInner<
    TRootSchema,
    TSchema,
    TParentPropertyDescriptor,
>
Returns PropertyDescriptorInner<TRootSchema, TSchema, TParentPropertyDescriptor>
- Defined in libs/schema/src/builders/SchemaBuilder.ts:113