Skip to content

noneof

noneof(cs: string | string[], m?: string): Parser

Parses a character if that character is not included in cs.

Example

const parser = noneof('Test')

const s = parse(parser, 'Exit')
console.log(status(s))  // "ok"
console.log(success(s)) // "E"

const f = parse(parser, 'Test')
console.log(status(f))  // "fail"
console.log(failure(f)) // Parse error at (line 1, column 1):
                        //
                        // Test
                        // ^
                        // Expected none of 'T', 'e', 's', or 't'

Parameters

  • cs: The set of characters that the next character is excluded from being a part of. This can be either a string or an array of single-character strings.
  • m: The optional expected error message that will take the place of the default error message.

Success

  • Succeeds if the next character is not one of the characters in cs. Consumes and returns that character.

Failure

  • Fails if the next character is any character in cs.

Throws

  • Throws an error if cs is not either a string or an array.
  • Throws an error if cs is an array but at least one of the elements is either not a string or is not exactly one character in length.
  • Throws an error if m exists and is not a string.

See Also