Skip to content

Commit

Permalink
docs: updated docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@tbjgolden
tbjgolden committed Mar 27, 2022
1 parent b58bdda commit 90a59e8
Show file tree
Hide file tree
Showing 2 changed files with 30 additions and 31 deletions.
6 changes: 3 additions & 3 deletions coverage/coverage-summary.json
View file
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
{"total": {"lines":{"total":649,"covered":560,"skipped":0,"pct":86.28},"statements":{"total":747,"covered":641,"skipped":0,"pct":85.8},"functions":{"total":23,"covered":23,"skipped":0,"pct":100},"branches":{"total":579,"covered":481,"skipped":0,"pct":83.07},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
{"total": {"lines":{"total":654,"covered":565,"skipped":0,"pct":86.39},"statements":{"total":749,"covered":645,"skipped":0,"pct":86.11},"functions":{"total":23,"covered":23,"skipped":0,"pct":100},"branches":{"total":564,"covered":470,"skipped":0,"pct":83.33},"branchesTrue":{"total":0,"covered":0,"skipped":0,"pct":"Unknown"}}
,"/Users/tom/Documents/media-query-parser/src/parse/lexicalAnalysis.ts": {"lines":{"total":369,"covered":320,"skipped":0,"pct":86.72},"functions":{"total":10,"covered":10,"skipped":0,"pct":100},"statements":{"total":440,"covered":377,"skipped":0,"pct":85.68},"branches":{"total":296,"covered":260,"skipped":0,"pct":87.83}}
,"/Users/tom/Documents/media-query-parser/src/parse/simplifyAST.ts": {"lines":{"total":25,"covered":21,"skipped":0,"pct":84},"functions":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":30,"covered":24,"skipped":0,"pct":80},"branches":{"total":18,"covered":16,"skipped":0,"pct":88.88}}
,"/Users/tom/Documents/media-query-parser/src/parse/syntacticAnalysis.ts": {"lines":{"total":255,"covered":219,"skipped":0,"pct":85.88},"functions":{"total":10,"covered":10,"skipped":0,"pct":100},"statements":{"total":277,"covered":240,"skipped":0,"pct":86.64},"branches":{"total":265,"covered":205,"skipped":0,"pct":77.35}}
,"/Users/tom/Documents/media-query-parser/src/parse/simplifyAST.ts": {"lines":{"total":23,"covered":19,"skipped":0,"pct":82.6},"functions":{"total":3,"covered":3,"skipped":0,"pct":100},"statements":{"total":28,"covered":23,"skipped":0,"pct":82.14},"branches":{"total":14,"covered":13,"skipped":0,"pct":92.85}}
,"/Users/tom/Documents/media-query-parser/src/parse/syntacticAnalysis.ts": {"lines":{"total":262,"covered":226,"skipped":0,"pct":86.25},"functions":{"total":10,"covered":10,"skipped":0,"pct":100},"statements":{"total":281,"covered":245,"skipped":0,"pct":87.18},"branches":{"total":254,"covered":197,"skipped":0,"pct":77.55}}
}
55 changes: 27 additions & 28 deletions docs/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -639,7 +639,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *number*]
**Returns:** [*number*, *number*]

Defined in:
[parse/lexicalAnalysis.ts:524](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L524)
Expand All @@ -658,7 +658,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *string*]
**Returns:** [*number*, *string*]

Defined in:
[parse/lexicalAnalysis.ts:734](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L734)
Expand All @@ -677,8 +677,8 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *string*, *<ident-token>* | *<function-token>*
| *<url-token>*]
**Returns:** [*number*, *string*, *<ident-token>* | *<function-token>* |
*<url-token>*]

Defined in:
[parse/lexicalAnalysis.ts:806](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L806)
Expand All @@ -697,7 +697,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *string*]
**Returns:** [*number*, *string*]

Defined in:
[parse/lexicalAnalysis.ts:695](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L695)
Expand All @@ -716,7 +716,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *number*, *number* | *integer*]
**Returns:** [*number*, *number*, *number* | *integer*]

Defined in:
[parse/lexicalAnalysis.ts:599](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L599)
Expand All @@ -736,9 +736,8 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [_number_, [*<number-token>*, *number*, *number* |
*integer*] | [*<percentage-token>*, *number*] | [*<dimension-token>*, *number*,
*string*]]
**Returns:** [_number_, [*<number-token>*, *number*, *number* | *integer*] |
[*<percentage-token>*, *number*] | [*<dimension-token>*, *number*, *string*]]

Defined in:
[parse/lexicalAnalysis.ts:566](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L566)
Expand All @@ -757,7 +756,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *string*]
**Returns:** [*number*, *string*]

Defined in:
[parse/lexicalAnalysis.ts:453](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L453)
Expand All @@ -766,7 +765,7 @@ Defined in:

### consumeUrl

▸ `Const`**consumeUrl**(`str`: _string_, `index`: _number_): _null_ | [*number*,
▸ `Const`**consumeUrl**(`str`: _string_, `index`: _number_): [*number*,
*string*]

#### Parameters:
Expand All @@ -776,7 +775,7 @@ Defined in:
| `str` | _string_ |
| `index` | _number_ |

**Returns:** _null_ | [*number*, *string*]
**Returns:** [*number*, *string*]

Defined in:
[parse/lexicalAnalysis.ts:773](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L773)
Expand All @@ -795,7 +794,7 @@ Defined in:
| `str` | _string_ | - |
| `index` | _number_ | 0 |

**Returns:** _null_ | [_Token_](README.md#token)[]
**Returns:** [_Token_](README.md#token)[]

Defined in:
[parse/lexicalAnalysis.ts:115](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/lexicalAnalysis.ts#L115)
Expand Down Expand Up @@ -823,15 +822,15 @@ Defined in:
### syntacticAnalysis

▸ `Const`**syntacticAnalysis**(`tokenList`: [_Token_](README.md#token)[]):
_null_ | [_MediaQuery_](README.md#mediaquery)[]
[_MediaQuery_](README.md#mediaquery)[]

#### Parameters:

| Name | Type |
| ----------- | ---------------------------- |
| `tokenList` | [_Token_](README.md#token)[] |

**Returns:** _null_ | [_MediaQuery_](README.md#mediaquery)[]
**Returns:** [_MediaQuery_](README.md#mediaquery)[]

Defined in:
[parse/syntacticAnalysis.ts:82](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/syntacticAnalysis.ts#L82)
Expand All @@ -840,15 +839,15 @@ Defined in:

### toAST

▸ `Const`**toAST**(`str`: _string_): _null_ | [_AST_](README.md#ast)
▸ `Const`**toAST**(`str`: _string_): [_AST_](README.md#ast)

#### Parameters:

| Name | Type |
| ----- | -------- |
| `str` | _string_ |

**Returns:** _null_ | [_AST_](README.md#ast)
**Returns:** [_AST_](README.md#ast)

Defined in:
[parse/syntacticAnalysis.ts:14](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/syntacticAnalysis.ts#L14)
Expand All @@ -857,15 +856,15 @@ Defined in:

### toUnflattenedAST

▸ `Const`**toUnflattenedAST**(`str`: _string_): _null_ | [_AST_](README.md#ast)
▸ `Const`**toUnflattenedAST**(`str`: _string_): [_AST_](README.md#ast)

#### Parameters:

| Name | Type |
| ----- | -------- |
| `str` | _string_ |

**Returns:** _null_ | [_AST_](README.md#ast)
**Returns:** [_AST_](README.md#ast)

Defined in:
[parse/syntacticAnalysis.ts:25](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/syntacticAnalysis.ts#L25)
Expand All @@ -875,7 +874,7 @@ Defined in:
### tokenizeMediaCondition

▸ `Const`**tokenizeMediaCondition**(`tokens`: WToken[], `mayContainOr`:
_boolean_, `previousOperator?`: _null_ | _and_ | _or_ | _not_): _null_ |
_boolean_, `previousOperator?`: _and_ | _or_ | _not_): _null_ |
[_MediaCondition_](README.md#mediacondition)

#### Parameters:
Expand All @@ -886,7 +885,7 @@ _boolean_, `previousOperator?`: _null_ | _and_ | _or_ | _not_): _null_ |
| `mayContainOr` | _boolean_ | - |
| `previousOperator` | _null_ | _and_ | _or_ | _not_ | null |

**Returns:** _null_ | [_MediaCondition_](README.md#mediacondition)
**Returns:** [_MediaCondition_](README.md#mediacondition)

Defined in:
[parse/syntacticAnalysis.ts:229](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/syntacticAnalysis.ts#L229)
Expand All @@ -906,7 +905,7 @@ Defined in:
| ----------- | -------- |
| `rawTokens` | WToken[] |

**Returns:** _null_ | [_MediaFeatureBoolean_](README.md#mediafeatureboolean) |
**Returns:** [_MediaFeatureBoolean_](README.md#mediafeatureboolean) |
[_MediaFeatureValue_](README.md#mediafeaturevalue) |
[_MediaFeatureRange_](README.md#mediafeaturerange)

Expand All @@ -926,7 +925,7 @@ Defined in:
| -------- | -------- |
| `tokens` | WToken[] |

**Returns:** _null_ | [_MediaQuery_](README.md#mediaquery)
**Returns:** [_MediaQuery_](README.md#mediaquery)

Defined in:
[parse/syntacticAnalysis.ts:123](https://github.com/tbjgolden/media-query-parser/blob/e9a76d1/src/parse/syntacticAnalysis.ts#L123)
Expand All @@ -935,8 +934,8 @@ Defined in:

### tokenizeRange

▸ `Const`**tokenizeRange**(`tokens`: ConvenientToken[]): _null_ | {
`featureName`: _string_ ; `leftOp`: _<_ | _<=_ ; `leftToken`:
▸ `Const`**tokenizeRange**(`tokens`: ConvenientToken[]): { `featureName`:
_string_ ; `leftOp`: _<_ | _<=_ ; `leftToken`:
[_ValidRangeToken_](README.md#validrangetoken) ; `rightOp`: _<_ | _<=_ ;
`rightToken`: [_ValidRangeToken_](README.md#validrangetoken) } | {
`featureName`: _string_ ; `leftOp`: _>_ | _>=_ ; `leftToken`:
Expand All @@ -954,9 +953,9 @@ Defined in:
| -------- | ----------------- |
| `tokens` | ConvenientToken[] |

**Returns:** _null_ | { `featureName`: _string_ ; `leftOp`: _<_ | _<=_ ;
`leftToken`: [_ValidRangeToken_](README.md#validrangetoken) ; `rightOp`: _<_ |
_<=_ ; `rightToken`: [_ValidRangeToken_](README.md#validrangetoken) } | {
**Returns:** { `featureName`: _string_ ; `leftOp`: _<_ | _<=_ ; `leftToken`:
[_ValidRangeToken_](README.md#validrangetoken) ; `rightOp`: _<_ | _<=_ ;
`rightToken`: [_ValidRangeToken_](README.md#validrangetoken) } | {
`featureName`: _string_ ; `leftOp`: _>_ | _>=_ ; `leftToken`:
[_ValidRangeToken_](README.md#validrangetoken) ; `rightOp`: _>_ | _>=_ ;
`rightToken`: [_ValidRangeToken_](README.md#validrangetoken) } | {
Expand Down

0 comments on commit 90a59e8

Please sign in to comment.