Skip to content

Commit

Permalink
chore(release): 2.0.11
Browse files Browse the repository at this point in the history
  • Loading branch information
thetutlage committed Feb 15, 2020
1 parent 2423c90 commit a2816a0
Show file tree
Hide file tree
Showing 10 changed files with 149 additions and 43 deletions.
3 changes: 1 addition & 2 deletions docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,8 @@

# edge-lexer


## Index

### External modules

* [lexer](modules/lexer.md)
* [lexer](modules/lexer.md)
19 changes: 9 additions & 10 deletions docs/classes/lexer.scanner.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Class: Scanner


Scan a string and seperate it into 2 pairs. The first pair will be series
of characters until the ending pattern is found and 2nd pair is the
left over.
Expand Down Expand Up @@ -56,16 +55,16 @@ first match.

### constructor

\+ **new Scanner**(`_pattern`: string, `_toleratePair`: [string, string], `_line`: number, `_col`: number): *[Scanner](lexer.scanner.md)*
\+ **new Scanner**(`pattern`: string, `toleratePair`: [string, string], `line`: number, `col`: number): *[Scanner](lexer.scanner.md)*

**Parameters:**

Name | Type |
------ | ------ |
`_pattern` | string |
`_toleratePair` | [string, string] |
`_line` | number |
`_col` | number |
`pattern` | string |
`toleratePair` | [string, string] |
`line` | number |
`col` | number |

**Returns:** *[Scanner](lexer.scanner.md)*

Expand Down Expand Up @@ -98,7 +97,7 @@ The matched content within the pattern

### scan

**scan**(`chunk`: any): *void*
**scan**(`chunk`: string): *void*

Scan a string and look for the closing pattern. The string will
be seperated with the closing pattern and also tracks the
Expand All @@ -109,7 +108,7 @@ scanner to end due to pattern mis-match.

Name | Type |
------ | ------ |
`chunk` | any |
`chunk` | string |

**Returns:** *void*

Expand All @@ -121,8 +120,8 @@ Name | Type |

### col

**col**: *number* = this._col
**col**: *number* = this.col

### line

**line**: *number* = this._line
**line**: *number* = this.line
35 changes: 28 additions & 7 deletions docs/classes/lexer.tokenizer.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Class: Tokenizer


Tokenizer converts a bunch of text into an array of tokens. Later
these tokens can be used to build the transformed text.

Expand All @@ -21,6 +20,8 @@ the tokens output.

### Properties

* [mustacheStatement](lexer.tokenizer.md#mustachestatement)
* [tagStatement](lexer.tokenizer.md#tagstatement)
* [tokens](lexer.tokenizer.md#tokens)

### Methods
Expand All @@ -31,23 +32,43 @@ the tokens output.

### constructor

\+ **new Tokenizer**(`_template`: string, `_tagsDef`: [Tags](../interfaces/lexer.tags.md), `_options`: object): *[Tokenizer](lexer.tokenizer.md)*
\+ **new Tokenizer**(`template`: string, `tagsDef`: [Tags](../interfaces/lexer.tags.md), `options`: object): *[Tokenizer](lexer.tokenizer.md)*

**Parameters:**

**template**: *string*

**tagsDef**: *[Tags](../interfaces/lexer.tags.md)*

**options**: *object*

Name | Type |
------ | ------ |
`_template` | string |
`_tagsDef` | [Tags](../interfaces/lexer.tags.md) |
`_options` | object |
`filename` | string |

**Returns:** *[Tokenizer](lexer.tokenizer.md)*

## Properties

### mustacheStatement

**mustacheStatement**: *null | object* = null

Holds the current tag statement, until it is closed

___

### tagStatement

**tagStatement**: *null | object* = null

Holds the current tag statement, until it is closed

___

### tokens

**tokens**: *[Token](../modules/lexer.md#token)[]* = []
**tokens**: *[Token](../modules/lexer.md#token)[]* = []

## Methods

Expand All @@ -57,4 +78,4 @@ Name | Type |

Parse the template and generate an AST out of it

**Returns:** *void*
**Returns:** *void*
3 changes: 1 addition & 2 deletions docs/enums/lexer.mustachetypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Enumeration: MustacheTypes


Types for mustache statements

## Index
Expand Down Expand Up @@ -36,4 +35,4 @@ ___

### SMUSTACHE

**SMUSTACHE**: = "s__mustache"
**SMUSTACHE**: = "s__mustache"
3 changes: 1 addition & 2 deletions docs/enums/lexer.tagtypes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Enumeration: TagTypes


The type of node types. Each token
will have one of these types

Expand All @@ -23,4 +22,4 @@ ___

### TAG

**TAG**: = "tag"
**TAG**: = "tag"
3 changes: 1 addition & 2 deletions docs/interfaces/lexer.lexertagdefinitioncontract.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,6 @@

# Interface: LexerTagDefinitionContract


The properties required by the lexer on a tag
definition

Expand All @@ -27,4 +26,4 @@ ___

### seekable

**seekable**: *boolean*
**seekable**: *boolean*
3 changes: 1 addition & 2 deletions docs/interfaces/lexer.tags.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,11 +2,10 @@

# Interface: Tags


## Hierarchy

* **Tags**

## Indexable

* \[ **name**: *string*\]: [LexerTagDefinitionContract](lexer.lexertagdefinitioncontract.md)
* \[ **name**: *string*\]: [LexerTagDefinitionContract](lexer.lexertagdefinitioncontract.md)
Loading

0 comments on commit a2816a0

Please sign in to comment.