parseBoolean

Creates a parse boolean transformation action.

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

Generics

TInput extends any
TConfig extends ParseBooleanConfig | undefined
TMessage extends ErrorMessage<ParseBooleanIssue<TInput>> | undefined

Parameters

config TConfig
message TMessage

Explanation

With parseBoolean you can parse certain "boolish" values into a plain boolean value (e.g. parsing environment variables). It supports both string and non-string values and the comparison is case-insensitive for strings.

By default, the truthy values are true, 1, "true", "1", "yes", "y", "on", and "enabled". The falsy values are false, 0, "false", "0", "no", "n", "off", and "disabled". You can override these defaults via the config argument.

Returns

Action ParseBooleanAction<TInput, TConfig, TMessage>

Examples

The following examples show how parseBoolean can be used.

const EnvSchema = v.object({
  // Default behavior
  PROD_MODE: v.pipe(v.string(), v.parseBoolean()),

  // With custom config
  LOG_MODE: v.pipe(
    v.string(),
    v.parseBoolean({
      truthy: ['verbose', 'chatty', 'record'],
      falsy: ['silent', 'quiet', 'mute'],
    })
  ),
});

The following APIs can be combined with parseBoolean.

Schemas

Methods

pipe