flatten

Объединяет сообщения об ошибках для проблем.

const errors = v.flatten<TSchema>(issues);

Обобщённые типы

• TSchema extends BaseSchema<unknown, unknown, BaseIssue<unknown>> | BaseSchemaAsync<unknown, unknown, BaseIssue<unknown>>

Параметры

• issues [InferIssue<TSchema>, ...InferIssue<TSchema>[]]

Пояснение

Сообщения об ошибках для проблем без пути, относящихся к корню схемы, добавляются к ключу .root.

Сообщения об ошибках для проблем с путём, относящихся к вложенным частям схемы и преобразуемых в путь через точку, добавляются к ключу .nested.

Некоторые пути проблем, например для сложных типов данных, таких как Set и Map, не имеют ключа или имеют ключ, который нельзя преобразовать в путь через точку. Эти сообщения об ошибках добавляются к ключу .other.

Возвращаемое значение

• errors FlatErrors<TSchema>

Примеры

Следующий пример показывает, как можно использовать flatten.

const Schema = v.object({
  nested: v.object({
    foo: v.string('Value of "nested.foo" is invalid.'),
  }),
});

const result = v.safeParse(Schema, { nested: { foo: null } });

if (result.issues) {
  const flatErrors = v.flatten<typeof Schema>(result.issues);

  // ...
}

Связанные материалы

Следующие API можно использовать вместе с flatten.

Методы

parse, parser, safeParse