Function flatten

flatten(
    issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]],
): {
    nested?: { readonly [key: string]: [string, ...string[]] | undefined };
    other?: [string, ...string[]];
    root?: [string, ...string[]];
}
Flatten the error messages of issues.
Parameters
- issues: [BaseIssue<unknown>, ...BaseIssue<unknown>[]]
  The list of issues.
Returns {
    nested?: { readonly [key: string]: [string, ...string[]] | undefined };
    other?: [string, ...string[]];
    root?: [string, ...string[]];
}
A flat error object.
- Optional Readonlynested?: { readonly [key: string]: [string, ...string[]] | undefined }
  The nested errors.
  
  Hint: The error messages of issues with a path that belong to the nested parts of the schema and can be converted to a dot path are added to this key.
- Optional Readonlyother?: [string, ...string[]]
  The other errors.
  
  Hint: Some issue paths, for example for complex data types like Set and Map, have no key or a key that cannot be converted to a dot path. These error messages are added to this key.
- Optional Readonlyroot?: [string, ...string[]]
  The root errors.
  
  Hint: The error messages of issues without a path that belong to the root of the schema are added to this key.
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/valibot/dist/index.d.mts:127
flatten<
    TSchema extends
        | BaseSchema<unknown, unknown, BaseIssue<unknown>>
        | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>,
>(
    issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]],
): {
    nested?: {
        [TKey in string]: Readonly<
            Partial<
                Record<
                    TSchema extends | BaseSchema<unknown, unknown, BaseIssue<(...)>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<(...)>>
                        ? IssueDotPath<TSchema<TSchema>>
                        : string,
                    [string, ...string[]],
                >,
            >,
        >[TKey]
    };
    other?: [string, ...string[]];
    root?: [string, ...string[]];
}
Flatten the error messages of issues.
Type Parameters
- TSchema extends
  | BaseSchema<unknown, unknown, BaseIssue<unknown>>
  | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>
Parameters
- issues: [InferIssue<TSchema>, ...InferIssue<TSchema>[]]
  The list of issues.
Returns {
    nested?: {
        [TKey in string]: Readonly<
            Partial<
                Record<
                    TSchema extends | BaseSchema<unknown, unknown, BaseIssue<(...)>>
                    | BaseSchemaAsync<unknown, unknown, BaseIssue<(...)>>
                        ? IssueDotPath<TSchema<TSchema>>
                        : string,
                    [string, ...string[]],
                >,
            >,
        >[TKey]
    };
    other?: [string, ...string[]];
    root?: [string, ...string[]];
}
A flat error object.
- Optional Readonlynested?: {
      [TKey in string]: Readonly<
          Partial<
              Record<
                  TSchema extends | BaseSchema<unknown, unknown, BaseIssue<(...)>>
                  | BaseSchemaAsync<unknown, unknown, BaseIssue<(...)>>
                      ? IssueDotPath<TSchema<TSchema>>
                      : string,
                  [string, ...string[]],
              >,
          >,
      >[TKey]
  }
  The nested errors.
  
  Hint: The error messages of issues with a path that belong to the nested parts of the schema and can be converted to a dot path are added to this key.
- Optional Readonlyother?: [string, ...string[]]
  The other errors.
  
  Hint: Some issue paths, for example for complex data types like Set and Map, have no key or a key that cannot be converted to a dot path. These error messages are added to this key.
- Optional Readonlyroot?: [string, ...string[]]
  The root errors.
  
  Hint: The error messages of issues without a path that belong to the root of the schema are added to this key.
- Defined in node_modules/.pnpm/[email protected][email protected]/node_modules/valibot/dist/index.d.mts:135

Function flatten

Parameters

Returns {
    nested?: { readonly [key: string]: [string, ...string[]] | undefined };
    other?: [string, ...string[]];
    root?: [string, ...string[]];
}

`Optional` `Readonly`nested?: { readonly [key: string]: [string, ...string[]] | undefined }

`Optional` `Readonly`other?: [string, ...string[]]

`Optional` `Readonly`root?: [string, ...string[]]

Type Parameters

Parameters

`Optional` `Readonly`other?: [string, ...string[]]

`Optional` `Readonly`root?: [string, ...string[]]

Settings

Function flatten

Parameters

Returns { nested?: { readonly [key: string]: [string, ...string[]] | undefined }; other?: [string, ...string[]]; root?: [string, ...string[]];}

Optional Readonlynested?: { readonly [key: string]: [string, ...string[]] | undefined }

Optional Readonlyother?: [string, ...string[]]

Optional Readonlyroot?: [string, ...string[]]

Type Parameters

Parameters

Optional Readonlynested?: { [TKey in string]: Readonly< Partial< Record< TSchema extends | BaseSchema<unknown, unknown, BaseIssue<(...)>> | BaseSchemaAsync<unknown, unknown, BaseIssue<(...)>> ? IssueDotPath<TSchema<TSchema>> : string, [string, ...string[]], >, >, >[TKey]}

Optional Readonlyother?: [string, ...string[]]

Optional Readonlyroot?: [string, ...string[]]

Settings

Returns {
nested?: { readonly [key: string]: [string, ...string[]] | undefined };
other?: [string, ...string[]];
root?: [string, ...string[]];
}

`Optional` `Readonly`nested?: { readonly [key: string]: [string, ...string[]] | undefined }

`Optional` `Readonly`other?: [string, ...string[]]

`Optional` `Readonly`root?: [string, ...string[]]

`Optional` `Readonly`nested?: {
[TKey in string]: Readonly<
Partial<
Record<
TSchema extends | BaseSchema<unknown, unknown, BaseIssue<(...)>>
| BaseSchemaAsync<unknown, unknown, BaseIssue<(...)>>
? IssueDotPath<TSchema<TSchema>>
: string,
[string, ...string[]],
>,
>,
>[TKey]
}

`Optional` `Readonly`other?: [string, ...string[]]

`Optional` `Readonly`root?: [string, ...string[]]