@smikhalevski/route-pattern

Index

Enumerations

NodeType

Interfaces

Type aliases

Functions

Type aliases

DataCallback

DataCallback: (data: string, start: number, end: number) => void

Type declaration

- (data: string, start: number, end: number): void
- Parameters
  - data: string
  - start: number
  - end: number
  Returns void

Node

Node: IPathNode | IPathSegmentNode | IAltNode | IVariableNode | IWildcardNode | IRegExpNode | ITextNode

OffsetCallback

OffsetCallback: (start: number, end: number) => void

Type declaration

- (start: number, end: number): void
- Parameters
  - start: number
  - end: number
  Returns void

Functions

convertNodeToRegExp

convertNodeToRegExp(node: Node, options?: INodeToRegExpConverterOptions): RegExp

- Defined in convertNodeToRegExp.ts:15
Converts pattern AST node to regular expression.

Parameters
- node: Node
  
  The node to convert to RegExp.
- options: INodeToRegExpConverterOptions = {}
  
  Other options.
Returns RegExp

convertPatternToRegExp

convertPatternToRegExp(str: string, options?: INodeToRegExpConverterOptions): RegExp

- Defined in convertPatternToRegExp.ts:7
Converts pattern to RegExp.

Parameters
- str: string
- Optional options: INodeToRegExpConverterOptions
Returns RegExp

parsePattern

parsePattern(str: string): IPathNode

- Defined in parsePattern.ts:11
Converts pattern to an AST.

throws

SyntaxError If unexpected syntax is met.

Parameters
- str: string
  
  The pattern to parse.
Returns IPathNode

The root node of the parsed AST.

tokenizePattern

tokenizePattern(str: string, options: IPatternTokenizerOptions): number

- Defined in tokenizePattern.ts:128
Traverses pattern and invokes callbacks when particular token in met.

Parameters
- str: string
  
  The pattern to tokenize.
- options: IPatternTokenizerOptions
  
  Callbacks to invoke during tokenization.
Returns number

The number of chars that were successfully parsed in str.

visitNode

visitNode(node: Node | null | undefined, visitor: INodeVisitor): void

- Defined in visitNode.ts:29
The pattern AST visitor.

Parameters
- node: Node | null | undefined
  
  The pattern AST root node to visit.
- visitor: INodeVisitor
  
  The set of callbacks to invoke when particular node is visited.
Returns void

Generated using TypeDoc