Skip to content

Built for people who want to own their automations. Join the waitlist for an invite.

Package listing

@kentcdodds/slack

src/validation.ts

38 lines · 1.3 KB · TypeScript
export type InputRecord = Record<string, unknown>

export function inputRecord(value: unknown): InputRecord {
  if (value === null || typeof value !== 'object' || Array.isArray(value)) {
    throw new Error('Input must be an object.')
  }
  return value as InputRecord
}

export function requiredString(input: InputRecord, key: string): string {
  const value = input[key]
  if (typeof value !== 'string' || value.trim().length === 0) {
    throw new Error(key + ' is required.')
  }
  return value
}

export function optionalString(input: InputRecord, key: string): string | undefined {
  const value = input[key]
  if (value === undefined || value === null || value === '') return undefined
  if (typeof value !== 'string') throw new Error(key + ' must be a string.')
  return value
}

export function boundedLimit(value: unknown, fallback = 100): number {
  if (value === undefined || value === null) return fallback
  if (!Number.isInteger(value) || Number(value) < 1 || Number(value) > 200) {
    throw new Error('limit must be an integer from 1 through 200.')
  }
  return Number(value)
}

export function optionalBoolean(input: InputRecord, key: string): boolean | undefined {
  const value = input[key]
  if (value === undefined || value === null) return undefined
  if (typeof value !== 'boolean') throw new Error(key + ' must be a boolean.')
  return value
}