parsnip-ts/Source - Documentation

import 'parsnip-ts/source'

Hierarchy

Source

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new Source(source: string, index: number, line?: number, column?: number): Source

- Defined in src/source.ts:4
Source for parsing

Parameters
- source: string
  
  Source input
- index: number
  
  Where in the input to begin parsing
- Default value line: number = 1
  
  Line which source[index] is on
- Default value column: number = 1
  
  Column which source[index] is on
Returns Source

Properties

column

column: number

Column which source[index] is on

index

index: number

Where in the input to begin parsing

line

line: number

Line which source[index] is on

source

source: string

Source input

Methods

getRemaining

getRemaining(): string

- Defined in src/source.ts:33
Get the remaining input

Returns string

match

match(regexp: RegExp, message?: undefined | string): ParseResult<string> | ParseError

- Defined in src/source.ts:42
Attempt to match the source against a regular expression

Parameters
- regexp: RegExp
  
  Regular expression to match
- Optional message: undefined | string
  
  Error message if it fails
Returns ParseResult<string> | ParseError

text

text(text: string, message?: undefined | string): ParseResult<string> | ParseError

- Defined in src/source.ts:77
Attempt to match the source against a literal string

Parameters
- text: string
  
  Text to match
- Optional message: undefined | string
  
  Error message, if it fails
Returns ParseResult<string> | ParseError

Generated using TypeDoc