12
12
13
13
## Contents
14
14
15
- * [ What is this?] ( #what-is-this )
16
- * [ When should I use this?] ( #when-should-i-use-this )
17
- * [ Install] ( #install )
18
- * [ Use] ( #use )
19
- * [ API] ( #api )
20
- * [ ` unified().use(retextKeywords[, options]) ` ] ( #unifieduseretextkeywords-options )
21
- * [ ` Keyphrase ` ] ( #keyphrase )
22
- * [ ` Keyword ` ] ( #keyword )
23
- * [ ` Options ` ] ( #options )
24
- * [ ` PhraseMatch ` ] ( #phrasematch )
25
- * [ ` WordMatch ` ] ( #wordmatch )
26
- * [ Types] ( #types )
27
- * [ Compatibility] ( #compatibility )
28
- * [ Contribute] ( #contribute )
29
- * [ License] ( #license )
15
+ * [ What is this?] ( #what-is-this )
16
+ * [ When should I use this?] ( #when-should-i-use-this )
17
+ * [ Install] ( #install )
18
+ * [ Use] ( #use )
19
+ * [ API] ( #api )
20
+ * [ ` unified().use(retextKeywords[, options]) ` ] ( #unifieduseretextkeywords-options )
21
+ * [ ` Keyphrase ` ] ( #keyphrase )
22
+ * [ ` Keyword ` ] ( #keyword )
23
+ * [ ` Options ` ] ( #options )
24
+ * [ ` PhraseMatch ` ] ( #phrasematch )
25
+ * [ ` WordMatch ` ] ( #wordmatch )
26
+ * [ Types] ( #types )
27
+ * [ Compatibility] ( #compatibility )
28
+ * [ Contribute] ( #contribute )
29
+ * [ License] ( #license )
30
30
31
31
## What is this?
32
32
@@ -142,8 +142,8 @@ The results are stored on `file.data.keyphrases`
142
142
143
143
###### Parameters
144
144
145
- * ` options ` ([ ` Options ` ] [ api-options ] , optional)
146
- — configuration
145
+ * ` options ` ([ ` Options ` ] [ api-options ] , optional)
146
+ — configuration
147
147
148
148
###### Returns
149
149
@@ -155,62 +155,62 @@ Info on a key phrase (TypeScript type).
155
155
156
156
###### Fields
157
157
158
- * ` matches ` ([ ` Array<PhraseMatch> ` ] [ api-phrase-match ] )
159
- — all matches
160
- * ` score ` (` number ` )
161
- — score of phrase, for one match
162
- * ` stems ` (` Array<string> ` )
163
- — stems of phrase
164
- * ` weight ` (` number ` )
165
- — score of phrase, for all matches
158
+ * ` matches ` ([ ` Array<PhraseMatch> ` ] [ api-phrase-match ] )
159
+ — all matches
160
+ * ` score ` (` number ` )
161
+ — score of phrase, for one match
162
+ * ` stems ` (` Array<string> ` )
163
+ — stems of phrase
164
+ * ` weight ` (` number ` )
165
+ — score of phrase, for all matches
166
166
167
167
### ` Keyword `
168
168
169
169
Info on a keyword (TypeScript type).
170
170
171
171
###### Fields
172
172
173
- * ` matches ` ([ ` Array<WordMatch> ` ] [ api-word-match ] )
174
- — all matches
175
- * ` score ` (` number ` )
176
- — score of word, for all matches
177
- * ` stem ` (` string ` )
178
- — stems of word
173
+ * ` matches ` ([ ` Array<WordMatch> ` ] [ api-word-match ] )
174
+ — all matches
175
+ * ` score ` (` number ` )
176
+ — score of word, for all matches
177
+ * ` stem ` (` string ` )
178
+ — stems of word
179
179
180
180
### ` Options `
181
181
182
182
Configuration (TypeScript type).
183
183
184
184
###### Fields
185
185
186
- * ` maximum ` (` number ` , default: ` 5 ` )
187
- — try to detect at most ` maximum ` words and phrases; actual counts may
188
- differ, for example, when two words have the same score, both will be
189
- returned; when too few words exist, less will be returned
186
+ * ` maximum ` (` number ` , default: ` 5 ` )
187
+ — try to detect at most ` maximum ` words and phrases; actual counts may
188
+ differ, for example, when two words have the same score, both will be
189
+ returned; when too few words exist, less will be returned
190
190
191
191
### ` PhraseMatch `
192
192
193
193
Match (TypeScript type).
194
194
195
195
###### Fields
196
196
197
- * ` nodes ` ([ ` Array<Node> ` ] [ nlcst-node ] )
198
- — matched nodes
199
- * ` parent ` ([ ` Node ` ] [ nlcst-node ] )
200
- — parent
197
+ * ` nodes ` ([ ` Array<Node> ` ] [ nlcst-node ] )
198
+ — matched nodes
199
+ * ` parent ` ([ ` Node ` ] [ nlcst-node ] )
200
+ — parent
201
201
202
202
### ` WordMatch `
203
203
204
204
Match (TypeScript type).
205
205
206
206
###### Fields
207
207
208
- * ` node ` ([ ` Node ` ] [ nlcst-node ] )
209
- — matched node
210
- * ` index ` (` number ` )
211
- — index of ` node ` in ` parent `
212
- * ` parent ` ([ ` Node ` ] [ nlcst-node ] )
213
- — parent
208
+ * ` node ` ([ ` Node ` ] [ nlcst-node ] )
209
+ — matched node
210
+ * ` index ` (` number ` )
211
+ — index of ` node ` in ` parent `
212
+ * ` parent ` ([ ` Node ` ] [ nlcst-node ] )
213
+ — parent
214
214
215
215
## Types
216
216
0 commit comments