@@ -10,60 +10,16 @@ Check if a [node][] is a (certain) [**HAST**][hast] [element][].
10
10
npm install hast-util-is-element
11
11
```
12
12
13
- ** hast-util-is-element** 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
- ``` javascript
21
- var isElement = require (' hast-util-is-element' );
22
- ```
23
-
24
- Given a non-element:
25
-
26
15
``` javascript
27
- var result = isElement ({
28
- ' type' : ' text' ,
29
- ' value' : ' foo'
30
- });
31
- ```
32
-
33
- Yields:
16
+ var is = require (' hast-util-is-element' );
34
17
35
- ``` js
36
- false
37
- ```
18
+ isElement ({type: ' text' , value: ' foo' }); // => false
38
19
39
- Given a matching element:
20
+ is ({type : ' element ' , tagName : ' a ' }, ' a ' ); // => true
40
21
41
- ``` javascript
42
- result = isElement ({
43
- ' type' : ' element' ,
44
- ' tagName' : ' a'
45
- }, ' a' );
46
- ```
47
-
48
- Yields:
49
-
50
- ``` js
51
- true
52
- ```
53
-
54
- Given multiple tagNames:
55
-
56
- ``` javascript
57
- result = isElement ({
58
- ' type' : ' element' ,
59
- ' tagName' : ' a'
60
- }, [' a' , ' area' ]);
61
- ```
62
-
63
- Yields:
64
-
65
- ``` js
66
- true
22
+ is ({type: ' element' , tagName: ' a' }, [' a' , ' area' ]); // => true
67
23
```
68
24
69
25
## API
@@ -76,15 +32,19 @@ When not given a second parameter, asserts if `node` is an element,
76
32
otherwise asserts ` node ` is an element whose ` tagName ` matches / is
77
33
included in the second parameter.
78
34
79
- ** Parameters** :
35
+ ###### Parameters
80
36
81
37
* ` node ` (` * ` ) — Value to check;
82
38
* ` tagName ` (` string ` , optional) — Value ` node ` s ` tagName ` must match;
83
39
* ` tagNames ` (` string ` , optional) — Value including ` node ` s ` tagName ` .
84
40
85
- ** Returns** : ` boolean ` , whether ` node ` passes the test.
41
+ ######Returns
42
+
43
+ ` boolean ` — whether ` node ` passes the test.
86
44
87
- ** Throws** : when the second parameter is given but invalid.
45
+ ###### Throws
46
+
47
+ ` Error ` — When the second parameter is given but invalid.
88
48
89
49
## License
90
50
@@ -102,8 +62,6 @@ included in the second parameter.
102
62
103
63
[ npm ] : https://docs.npmjs.com/cli/install
104
64
105
- [ releases ] : https://github.com/wooorm/hast-util-is-element/releases
106
-
107
65
[ license ] : LICENSE
108
66
109
67
[ author ] : http://wooorm.com
0 commit comments