Creates a LiteralTypeGuard that checks that the value equals one of the values.
LiteralTypeGuard
values
Best practice: use satisfies on the result when passing multiple literal values.
satisfies
Array of literal values
The literal values to guard for
A type guard for the provided values
const isHello = isLiteral("Hello");isHello("Hello"); // trueisHello("world"); // false Copy
const isHello = isLiteral("Hello");isHello("Hello"); // trueisHello("world"); // false
const directions = ["up", "down", "left", "right"] as const;type Direction = (typeof directions)[number];const isDirection = isLiteral(...directions) satisfies TypeGuard<Direction>;isDirection("up"); // true Copy
const directions = ["up", "down", "left", "right"] as const;type Direction = (typeof directions)[number];const isDirection = isLiteral(...directions) satisfies TypeGuard<Direction>;isDirection("up"); // true
Creates a
LiteralTypeGuardthat checks that the value equals one of thevalues.Best practice: use
satisfieson the result when passing multiple literal values.