Skip to content

parseBooleanOrString

parseBooleanOrString(value): BooleanOrStringParseResult

Defined in: _worktrees/docs-release/gaunt-sloth/packages/core/src/utils/consoleUtils.ts:299

Parse a CLI option value into either:

  • a boolean (when value looks like a true/false token),
  • a non-empty string (otherwise),
  • or none (when value is nullish or only whitespace).

Recognized false-like tokens (case-insensitive): ‘false’, ‘0’, ‘n’, ‘no’ Recognized true-like tokens (case-insensitive): ‘true’, ‘1’, ‘y’, ‘yes’

Examples: parseBooleanOrString(‘n’) => { kind: ‘boolean’, value: false } parseBooleanOrString(‘0’) => { kind: ‘boolean’, value: false } parseBooleanOrString(‘true’) => { kind: ‘boolean’, value: true } parseBooleanOrString(‘1’) => { kind: ‘boolean’, value: true } parseBooleanOrString(‘review.md’) => { kind: ‘string’, value: ‘review.md’ } parseBooleanOrString(’ ’) => { kind: ‘none’ } parseBooleanOrString(undefined) => { kind: ‘none’ }

unknown

BooleanOrStringParseResult