README.md

tinypratt

a tiny pratt parser implementation

npm i tinypratt

pnpm add tinypratt

yarn add tinypratt

API

# ParserErrorCauses

src/causes.ts#L1

# BadImpl

src/causes.ts#L33

# constructor(token, impl)

src/causes.ts#L35

# new BadImpl()

BadImpl

# token

Token

# impl

keyof Impl

# col

src/causes.ts#L9

number

# impl

src/causes.ts#L35

keyof Impl

# index

src/causes.ts#L6

number

# input

src/causes.ts#L7

string

# line

src/causes.ts#L8

number

# message

src/causes.ts#L10

string

# name  =  'ParserBadImpl'

src/causes.ts#L34

string

# short

src/causes.ts#L11

string

# token

src/causes.ts#L11

Token

# BadOp

src/causes.ts#L42

# constructor(token, short)

src/causes.ts#L11

# new BadOp()

BadOp

# token

Token

# short

string

# col

src/causes.ts#L9

number

# index

src/causes.ts#L6

number

# input

src/causes.ts#L7

string

# line

src/causes.ts#L8

number

# message

src/causes.ts#L10

string

# name  =  'ParserBadOp'

src/causes.ts#L43

string

# short

src/causes.ts#L11

string

# token

src/causes.ts#L11

Token

# BadToken

src/causes.ts#L39

# constructor(token, short)

src/causes.ts#L11

# new BadToken()

BadToken

# token

Token

# short

string

# col

src/causes.ts#L9

number

# index

src/causes.ts#L6

number

# input

src/causes.ts#L7

string

# line

src/causes.ts#L8

number

# message

src/causes.ts#L10

string

# name  =  'ParserBadToken'

src/causes.ts#L40

string

# short

src/causes.ts#L11

string

# token

src/causes.ts#L11

Token

# ParserErrorCause

src/causes.ts#L4

# constructor(token, short)

src/causes.ts#L11

# new ParserErrorCause()

ParserErrorCause

# token

Token

# short

string

# col

src/causes.ts#L9

number

# index

src/causes.ts#L6

number

# input

src/causes.ts#L7

string

# line

src/causes.ts#L8

number

# message

src/causes.ts#L10

string

# name  =  'ParserUnknownError'

src/causes.ts#L5

string

# short

src/causes.ts#L11

string

# token

src/causes.ts#L11

Token

# UnexpectedToken

src/causes.ts#L27

# constructor(token, group, value)

src/causes.ts#L29

# new UnexpectedToken()

UnexpectedToken

# token

Token

# group

string

# value

string

# col

src/causes.ts#L9

number

# group

src/causes.ts#L29

string

# index

src/causes.ts#L6

number

# input

src/causes.ts#L7

string

# line

src/causes.ts#L8

number

# message

src/causes.ts#L10

string

# name  =  'ParserUnexpectedToken'

src/causes.ts#L28

string

# short

src/causes.ts#L11

string

# token

src/causes.ts#L11

Token

# value

src/causes.ts#L29

string

# LexerError

# constructor(cause)

# new LexerError()

LexerError

# cause

Error

# cause

UnexpectedToken

# name

string

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces)  =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt)  =>

void

# ParserError

src/index.ts#L58

# constructor(cause)

src/index.ts#L67

# new ParserError()

ParserError

# cause

Error

# cause

src/index.ts#L59

UnexpectedToken | BadImpl | BadToken | BadOp

# name  =  'ParserError'

src/index.ts#L66

string

# prepareStackTrace

# (err, stackTraces)

# err

Error

# stackTraces

CallSite []

(err, stackTraces)  =>

any

# stackTraceLimit

number

# captureStackTrace(targetObject, constructorOpt)

# targetObject

object

# constructorOpt

Function

captureStackTrace(targetObject, constructorOpt)  =>

void

# Token

# constructor(value)

# new Token()

Token

# value

TokenJson

# new Token()

Token

# value

string

# group

string

# source

RegExpMatchArrayLike

# group

string

# source

RegExpMatchArrayLike

# index
# value
# as(value, group)

# value

string

# group

string

as(value, group)  =>

Token

# is(group, value)

# group

string

# value

string

is(group, value)  =>

boolean

# toJSON()

toJSON()  =>

TokenJson

# create(value, group, source)

# value

string

# group

string

# source

RegExpMatchArrayLike

create(value, group, source)  =>

Token

# Impl

src/index.ts#L28

# led

src/index.ts#L29

Fn

# nud

src/index.ts#L30

Fn

# NodeArray

src/index.ts#L12

# TokenJson

# group

string

# source

{

# index

number

# input

string

# match

string []

}

# value

string

# Node

src/index.ts#L16

NodeArray | Token & {

# lexer

src/index.ts#L17

Lexer

# toString()

src/index.ts#L18

toString()  =>

string

}

# createParser(regexp, fn)

src/index.ts#L72

# regexp

RegExp

# fn

ImplTableFactory

createParser(regexp, fn)  =>

# (input)

# input

string

(input)  =>

Node

# joinRegExp(regexps, flags)

# regexps

RegExp | RegExp [] []

# flags

string

joinRegExp(regexps, flags)  =>

RegExp

Credits

• annotate-code by stagas – beautifully annotate source code with a message, given an index, like a parser or compiler
• join-regexp by stagas – utility to join regexps together
• lexer-next by stagas – lexer for recursive descent parsers

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2022 stagas