parseJson

Создает действие преобразования для разбора JSON.

const Action = v.parseJson<TInput, TConfig, TMessage>(config, message);

Обобщения

• TInput extends string
• TConfig extends ParseJsonConfig | undefined
• TMessage extends ErrorMessage<ParseJsonIssue<TInput>> | undefined

Параметры

• config TConfig
• message TMessage

Пояснение

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

Возвращает

• Action ParseJsonAction<TInput, TConfig, TMessage>

Примеры

В следующих примерах показано, как можно использовать parseJson.

Разбор и проверка JSON

Разберите строку JSON и проверьте результат.

const StringifiedObjectSchema = v.pipe(
  v.string(),
  v.parseJson(),
  v.object({ key: v.string() })
);

Разбор JSON с функцией reviver

Разберите строку JSON с помощью функции reviver.

const StringifiedObjectSchema = v.pipe(
  v.string(),
  v.parseJson({
    reviver: (key, value) =>
      typeof value === 'string' ? value.toUpperCase() : value,
  }),
  v.object({ key: v.string() })
);

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

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

Схемы

any, custom, string

Методы

pipe

Утилиты

isOfKind, isOfType