File tree 1 file changed +14
-38
lines changed
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].
10
10
npm install unist-util-generated
11
11
```
12
12
13
- ** unist-util-generated** is also available as an AMD, CommonJS, and
14
- globals module, [ uncompressed and compressed] [ releases ] .
15
-
16
13
## Usage
17
14
18
- Dependencies:
19
-
20
15
``` javascript
21
16
var generated = require (' unist-util-generated' );
22
- ```
23
-
24
- Checks:
25
17
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
47
19
48
- Yields:
20
+ generated ({
21
+ position: {start: {}, end: {}}
22
+ }); // => true
49
23
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
54
30
```
55
31
56
32
## API
@@ -59,11 +35,13 @@ c: false
59
35
60
36
Detect if [ ` node ` ] [ node ] is [ ** generated** ] [ spec ] .
61
37
62
- ** Parameters** :
38
+ ###### Parameters
63
39
64
40
* ` node ` ([ ` Node ` ] [ node ] ) — Node to check.
65
41
66
- ** Returns** : Whether ` node ` is generated.
42
+ ###### Returns
43
+
44
+ ` boolean ` — Whether ` node ` is generated.
67
45
68
46
## License
69
47
@@ -81,8 +59,6 @@ Detect if [`node`][node] is [**generated**][spec].
81
59
82
60
[ npm ] : https://docs.npmjs.com/cli/install
83
61
84
- [ releases ] : https://github.com/wooorm/unist-util-generated/releases
85
-
86
62
[ license ] : LICENSE
87
63
88
64
[ author ] : http://wooorm.com
You can’t perform that action at this time.
0 commit comments