File tree Expand file tree Collapse file tree 1 file changed +14
-38
lines changed Expand file tree Collapse file tree 1 file changed +14
-38
lines changed Original file line number Diff line number Diff line change @@ -10,47 +10,23 @@ Check if a [**Unist**][unist] [node][] is [**generated**][spec].
1010npm install unist-util-generated
1111```
1212
13- ** unist-util-generated** is also available as an AMD, CommonJS, and
14- globals module, [ uncompressed and compressed] [ releases ] .
15-
1613## Usage
1714
18- Dependencies:
19-
2015``` javascript
2116var generated = require (' unist-util-generated' );
22- ```
23-
24- Checks:
2517
26- ``` javascript
27- var a = generated ({});
28- var b = generated ({
29- ' position' : {
30- ' start' : {},
31- ' end' : {}
32- }
33- });
34- var c = generated ({
35- ' position' : {
36- ' start' : {
37- ' line' : 1 ,
38- ' column' : 1
39- },
40- ' end' : {
41- ' line' : 1 ,
42- ' column' : 2
43- }
44- }
45- });
46- ```
18+ generated ({}); // => true
4719
48- Yields:
20+ generated ({
21+ position: {start: {}, end: {}}
22+ }); // => true
4923
50- ``` txt
51- a: true
52- b: true
53- c: false
24+ generated ({
25+ position: {
26+ start: {line: 1 , column: 1 },
27+ end: {line: 1 , column: 2 }
28+ }
29+ }); // => false
5430```
5531
5632## API
@@ -59,11 +35,13 @@ c: false
5935
6036Detect if [ ` node ` ] [ node ] is [ ** generated** ] [ spec ] .
6137
62- ** Parameters** :
38+ ###### Parameters
6339
6440* ` node ` ([ ` Node ` ] [ node ] ) — Node to check.
6541
66- ** Returns** : Whether ` node ` is generated.
42+ ###### Returns
43+
44+ ` boolean ` — Whether ` node ` is generated.
6745
6846## License
6947
@@ -81,8 +59,6 @@ Detect if [`node`][node] is [**generated**][spec].
8159
8260[ npm ] : https://docs.npmjs.com/cli/install
8361
84- [ releases ] : https://github.com/wooorm/unist-util-generated/releases
85-
8662[ license ] : LICENSE
8763
8864[ author ] : http://wooorm.com
You can’t perform that action at this time.
0 commit comments