cleaners/src/cleaners/primitives.js

Cleans & validates untrusted data, with TypeScript & Flow support

import { showValue } from '../showValue.js'
import { asOptional } from './asOptional.js'
import { asValue } from './asValue.js'

export function asBoolean(raw) {
  if (typeof raw !== 'boolean') {
    throw new TypeError('Expected a boolean, got ' + showValue(raw))
  }
  return raw
}

export function asNumber(raw) {
  if (typeof raw !== 'number') {
    throw new TypeError('Expected a number, got ' + showValue(raw))
  }
  return raw
}

export function asString(raw) {
  if (typeof raw !== 'string') {
    throw new TypeError('Expected a string, got ' + showValue(raw))
  }
  return raw
}

export const asNull = asValue(null)
export const asUndefined = asValue(undefined)

export function asUnknown(raw) {
  return raw
}

// Deprecated:
export const asNone = asOptional(asNull)