On this page

eof primitive

Signature

ts

function eof(): Parser<null>

Description

eof only succeeds (with null) at the end of the input.

Usage

ts

const Parser = sequence(
  string('<start>'),
  string('<body>'),
  string('<end>'),
  eof()
)

Success

ts

run(Parser).with(`<start><body><end>`)

{
  isOk: true,
  span: [ 0, 18 ],
  pos: 18,
  value: [ '<start>', '<body>', '<end>', null ]
}

Failure

ts

run(Parser).with(`<start><body><end>\n`)

{
  isOk: false,
  span: [ 18, 18 ],
  pos: 18,
  expected: 'end of input'
}