Spec-Zone.ru › Valibot

stringifyJson

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

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

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

  • TInput extends any
  • TConfig extends StringifyJsonConfig | undefined
  • TMessage extends ErrorMessage<StringifyJsonIssue<TInput>> | undefined

Параметры

  • config TConfig
  • message TMessage

Пояснение

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

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

  • Action StringifyJsonAction<TInput, TConfig, TMessage>

Примеры

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

Сериализация JSON

Сериализуйте объект JSON.

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

Сериализация JSON с функцией-заместителем

Сериализуйте объект JSON с помощью функции-заместителя.

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

Связанные API

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

Схемы

any, array, boolean, custom, date, enum, exactOptional, instance, intersect, lazy, literal, looseObject, looseTuple, nonNullable, nonNullish, nonOptional, null, nullable, nullish, number, object, objectWithRest, picklist, record, strictObject, strictTuple, string, tuple, tupleWithRest, union, unknown, variant

Методы

pipe

Утилиты

isOfKind, isOfType

© Fabian Hiller
Licensed under the MIT License.
https://valibot.dev/api/stringifyJson/

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API