@@ -43,7 +43,7 @@ does the same but for [remark][].
43
43
## Install
44
44
45
45
This package is [ ESM only] [ esm ] .
46
- In Node.js (version 12.20+, 14.14+, or 16.0+), install with [ npm] [ ] :
46
+ In Node.js (version 14.14+ and 16.0+), install with [ npm] [ ] :
47
47
48
48
``` sh
49
49
npm install mdast-util-squeeze-paragraphs
@@ -91,27 +91,33 @@ Yields:
91
91
92
92
## API
93
93
94
- This package exports the identifier ` squeezeParagraphs ` .
94
+ This package exports the identifier
95
+ [ ` squeezeParagraphs ` ] [ api-squeezeparagraphs ] .
95
96
There is no default export.
96
97
97
98
### ` squeezeParagraphs(tree) `
98
99
99
- Remove empty paragraphs in ` tree ` ([ ` Node ` ] [ node ] ).
100
+ Remove empty paragraphs in ` tree ` .
101
+
102
+ ###### Parameters
103
+
104
+ * ` tree ` ([ ` Node ` ] [ node ] )
105
+ — tree to change
100
106
101
107
###### Returns
102
108
103
- The given ` tree ` ([ ` Node ` ] [ node ] ).
109
+ Changed ` tree ` ([ ` Node ` ] [ node ] ), or ` null ` if it was an empty paragraph .
104
110
105
111
## Types
106
112
107
113
This package is fully typed with [ TypeScript] [ ] .
108
- There are no additional types exported .
114
+ It exports no additional types. .
109
115
110
116
## Compatibility
111
117
112
118
Projects maintained by the unified collective are compatible with all maintained
113
119
versions of Node.js.
114
- As of now, that is Node.js 12.20+, 14.14+, and 16.0+.
120
+ As of now, that is Node.js 14.14+ and 16.0+.
115
121
Our projects sometimes work with older versions, but this is not guaranteed.
116
122
117
123
## Security
@@ -197,3 +203,5 @@ abide by its terms.
197
203
[ remark ] : https://github.com/remarkjs/remark
198
204
199
205
[ remark-squeeze-paragraphs ] : https://github.com/remarkjs/remark-squeeze-paragraphs
206
+
207
+ [ api-squeezeparagraphs ] : #squeezeparagraphstree
0 commit comments