Function findValidUnionValue

findValidUnionValue<T, V>(value: V, values: readonly T[]): T

Find if an unknown value is within a Typescript safe "union" values array

Type Parameters

T
V

Parameters

value: V
Value to test
values: readonly T[]
"Union" values array

Returns T

found value if found

Throws

InvalidUnionValueError if value not found

Example

const sheepNames = ['Capn Frisky', 'Mr. Snugs', 'Lambchop'] as const
  type SheepName = typeof sheepNames[number]
  try {
    const validValue: SheepName = findValidUnionValue(JSON.parse('"Capn Frisky"'), sheepNames)
  } catch (e) {
  if (e instanceof InvalidUnionValueException) {
    console.error(e.message)
    return
  }
  throw e
}