Skip to content

Commit ffc308e

Browse files
Zearinmichaelficarra
authored andcommitted
Update README.md
Minor formatting tweaks to README.md.
1 parent c962432 commit ffc308e

File tree

1 file changed

+41
-41
lines changed

1 file changed

+41
-41
lines changed

README.md

Lines changed: 41 additions & 41 deletions
Original file line numberDiff line numberDiff line change
@@ -4,29 +4,29 @@ utility box for ECMAScript language tools.
44

55
### API
66

7-
### ast
7+
### `ast`
88

9-
#### ast.isExpression(node)
9+
#### `ast.isExpression(node)`
1010

11-
Returns true if `node` is an Expression as defined in ECMA262 edition 5.1 section
11+
Returns `true` if `node` is an Expression as defined in ECMA262 edition 5.1 section
1212
[11](https://es5.github.io/#x11).
1313

14-
#### ast.isStatement(node)
14+
#### `ast.isStatement(node)`
1515

16-
Returns true if `node` is a Statement as defined in ECMA262 edition 5.1 section
16+
Returns `true` if `node` is a Statement as defined in ECMA262 edition 5.1 section
1717
[12](https://es5.github.io/#x12).
1818

19-
#### ast.isIterationStatement(node)
19+
#### `ast.isIterationStatement(node)`
2020

21-
Returns true if `node` is an IterationStatement as defined in ECMA262 edition
21+
Returns `true` if `node` is an IterationStatement as defined in ECMA262 edition
2222
5.1 section [12.6](https://es5.github.io/#x12.6).
2323

24-
#### ast.isSourceElement(node)
24+
#### `ast.isSourceElement(node)`
2525

26-
Returns true if `node` is a SourceElement as defined in ECMA262 edition 5.1
26+
Returns `true` if `node` is a SourceElement as defined in ECMA262 edition 5.1
2727
section [14](https://es5.github.io/#x14).
2828

29-
#### ast.trailingStatement(node)
29+
#### `ast.trailingStatement(node)`
3030

3131
Returns `Statement?` if `node` has trailing `Statement`.
3232
```js
@@ -35,9 +35,9 @@ if (cond)
3535
```
3636
When taking this `IfStatement`, returns `consequent;` statement.
3737

38-
#### ast.isProblematicIfStatement(node)
38+
#### `ast.isProblematicIfStatement(node)`
3939

40-
Returns true if `node` is a problematic IfStatement. If `node` is a problematic `IfStatement`, `node` cannot be represented as an one on one JavaScript code.
40+
Returns `true` if `node` is a problematic IfStatement. If `node` is a problematic `IfStatement`, `node` cannot be represented as an one on one JavaScript code.
4141
```js
4242
{
4343
type: 'IfStatement',
@@ -54,47 +54,47 @@ Returns true if `node` is a problematic IfStatement. If `node` is a problematic
5454
The above node cannot be represented as a JavaScript code, since the top level `else` alternate belongs to an inner `IfStatement`.
5555

5656

57-
### code
57+
### `code`
5858

59-
#### code.isDecimalDigit(code)
59+
#### `code.isDecimalDigit(code)`
6060

61-
Return true if provided code is decimal digit.
61+
Return `true` if provided code is decimal digit.
6262

63-
#### code.isHexDigit(code)
63+
#### `code.isHexDigit(code)`
6464

65-
Return true if provided code is hexadecimal digit.
65+
Return `true` if provided code is hexadecimal digit.
6666

67-
#### code.isOctalDigit(code)
67+
#### `code.isOctalDigit(code)`
6868

69-
Return true if provided code is octal digit.
69+
Return `true` if provided code is octal digit.
7070

71-
#### code.isWhiteSpace(code)
71+
#### `code.isWhiteSpace(code)`
7272

73-
Return true if provided code is white space. White space characters are formally defined in ECMA262.
73+
Return `true` if provided code is white space. White space characters are formally defined in ECMA262.
7474

75-
#### code.isLineTerminator(code)
75+
#### `code.isLineTerminator(code)`
7676

77-
Return true if provided code is line terminator. Line terminator characters are formally defined in ECMA262.
77+
Return `true` if provided code is line terminator. Line terminator characters are formally defined in ECMA262.
7878

79-
#### code.isIdentifierStart(code)
79+
#### `code.isIdentifierStart(code)`
8080

81-
Return true if provided code can be the first character of ECMA262 Identifier. They are formally defined in ECMA262.
81+
Return `true` if provided code can be the first character of ECMA262 Identifier. They are formally defined in ECMA262.
8282

83-
#### code.isIdentifierPart(code)
83+
#### `code.isIdentifierPart(code)`
8484

85-
Return true if provided code can be the trailing character of ECMA262 Identifier. They are formally defined in ECMA262.
85+
Return `true` if provided code can be the trailing character of ECMA262 Identifier. They are formally defined in ECMA262.
8686

87-
### keyword
87+
### `keyword`
8888

89-
#### keyword.isKeywordES5(id, strict)
89+
#### `keyword.isKeywordES5(id, strict)`
9090

9191
Returns `true` if provided identifier string is a Keyword or Future Reserved Word
9292
in ECMA262 edition 5.1. They are formally defined in ECMA262 sections
9393
[7.6.1.1](http://es5.github.io/#x7.6.1.1) and [7.6.1.2](http://es5.github.io/#x7.6.1.2),
9494
respectively. If the `strict` flag is truthy, this function additionally checks whether
9595
`id` is a Keyword or Future Reserved Word under strict mode.
9696

97-
#### keyword.isKeywordES6(id, strict)
97+
#### `keyword.isKeywordES6(id, strict)`
9898

9999
Returns `true` if provided identifier string is a Keyword or Future Reserved Word
100100
in ECMA262 edition 6. They are formally defined in ECMA262 sections
@@ -103,46 +103,46 @@ in ECMA262 edition 6. They are formally defined in ECMA262 sections
103103
respectively. If the `strict` flag is truthy, this function additionally checks whether
104104
`id` is a Keyword or Future Reserved Word under strict mode.
105105

106-
#### keyword.isReservedWordES5(id, strict)
106+
#### `keyword.isReservedWordES5(id, strict)`
107107

108108
Returns `true` if provided identifier string is a Reserved Word in ECMA262 edition 5.1.
109109
They are formally defined in ECMA262 section [7.6.1](http://es5.github.io/#x7.6.1).
110110
If the `strict` flag is truthy, this function additionally checks whether `id`
111111
is a Reserved Word under strict mode.
112112

113-
#### keyword.isReservedWordES6(id, strict)
113+
#### `keyword.isReservedWordES6(id, strict)`
114114

115115
Returns `true` if provided identifier string is a Reserved Word in ECMA262 edition 6.
116116
They are formally defined in ECMA262 section [11.6.2](http://ecma-international.org/ecma-262/6.0/#sec-reserved-words).
117117
If the `strict` flag is truthy, this function additionally checks whether `id`
118118
is a Reserved Word under strict mode.
119119

120-
#### keyword.isRestrictedWord(id)
120+
#### `keyword.isRestrictedWord(id)`
121121

122122
Returns `true` if provided identifier string is one of `eval` or `arguments`.
123123
They are restricted in strict mode code throughout ECMA262 edition 5.1 and
124124
in ECMA262 edition 6 section [12.1.1](http://ecma-international.org/ecma-262/6.0/#sec-identifiers-static-semantics-early-errors).
125125

126-
#### keyword.isIdentifierNameES5(id)
126+
#### `keyword.isIdentifierNameES5(id)`
127127

128-
Return true if provided identifier string is an IdentifierName as specified in
128+
Return `true` if provided identifier string is an IdentifierName as specified in
129129
ECMA262 edition 5.1 section [7.6](https://es5.github.io/#x7.6).
130130

131-
#### keyword.isIdentifierNameES6(id)
131+
#### `keyword.isIdentifierNameES6(id)`
132132

133-
Return true if provided identifier string is an IdentifierName as specified in
133+
Return `true` if provided identifier string is an IdentifierName as specified in
134134
ECMA262 edition 6 section [11.6](http://ecma-international.org/ecma-262/6.0/#sec-names-and-keywords).
135135

136-
#### keyword.isIdentifierES5(id, strict)
136+
#### `keyword.isIdentifierES5(id, strict)`
137137

138-
Return true if provided identifier string is an Identifier as specified in
138+
Return `true` if provided identifier string is an Identifier as specified in
139139
ECMA262 edition 5.1 section [7.6](https://es5.github.io/#x7.6). If the `strict`
140140
flag is truthy, this function additionally checks whether `id` is an Identifier
141141
under strict mode.
142142

143-
#### keyword.isIdentifierES6(id, strict)
143+
#### `keyword.isIdentifierES6(id, strict)`
144144

145-
Return true if provided identifier string is an Identifier as specified in
145+
Return `true` if provided identifier string is an Identifier as specified in
146146
ECMA262 edition 6 section [12.1](http://ecma-international.org/ecma-262/6.0/#sec-identifiers).
147147
If the `strict` flag is truthy, this function additionally checks whether `id`
148148
is an Identifier under strict mode.

0 commit comments

Comments
 (0)