Skip to content
On this page

oneOf primitive

Signature

ts
function oneOf(): Parser<string>

Description

oneOf ensures that one of the characters in the given string matches the current character.

Usage

ts
const Parser = oneOf('xyz')

Success

ts
run(Parser).with('y-combinator')

{
  isOk: true,
  span: [ 0, 1 ],
  pos: 1,
  value: 'y'
}

Failure

ts
run(Parser).with('q-combinator')

{
  isOk: false,
  span: [ 0, 0 ],
  pos: 0,
  expected: 'one of: x, y, z'
}