Skip to content

Commit bb3e687

Browse files
committed
Refactor definition casing
1 parent a12dc92 commit bb3e687

File tree

1 file changed

+14
-14
lines changed

1 file changed

+14
-14
lines changed

readme.md

Lines changed: 14 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -147,8 +147,8 @@ console.log(toJs(estree, {handlers: jsx}).value)
147147

148148
## API
149149

150-
This package exports the identifiers [`defaultHandlers`][defaulthandlers] and
151-
[`toEstree`][toestree].
150+
This package exports the identifiers [`defaultHandlers`][api-default-handlers]
151+
and [`toEstree`][api-to-estree].
152152
There is no default export.
153153

154154
### `toEstree(tree[, options])`
@@ -167,7 +167,7 @@ You may have to do `program.comments = undefined` for certain compilers.
167167

168168
* `tree` ([`HastNode`][hast-node])
169169
— hast tree
170-
* `options` ([`Options`][options], optional)
170+
* `options` ([`Options`][api-options], optional)
171171
— configuration
172172

173173
###### Returns
@@ -192,7 +192,7 @@ calls, and then serialize with whatever (`astring`, `escodegen`).
192192

193193
Default handlers for elements (`Record<string, Handle>`).
194194

195-
Each key is a node type, each value is a [`Handle`][handle].
195+
Each key is a node type, each value is a [`Handle`][api-handle].
196196

197197
### `ElementAttributeNameCase`
198198

@@ -215,7 +215,7 @@ Turn a hast node into an estree node (TypeScript type).
215215
216216
* `node` ([`HastNode`][hast-node])
217217
— expected hast node
218-
* `state` ([`State`][state])
218+
* `state` ([`State`][api-state])
219219
— info passed around about the current state
220220
221221
###### Returns
@@ -238,7 +238,7 @@ Configuration (TypeScript type).
238238
manually)
239239
* `handlers` (`Record<string, Handle>`, optional)
240240
— custom handlers
241-
* `space` ([`Space`][space], default: `'html'`).
241+
* `space` ([`Space`][api-space], default: `'html'`).
242242
which space the document is in; when an `<svg>` element is found in the
243243
HTML space, this package already automatically switches to and from the SVG
244244
space when entering and exiting it
@@ -287,8 +287,8 @@ Info passed around about the current state (TypeScript type).
287287
This package is fully typed with [TypeScript][].
288288
It exports the additional types
289289
[`ElementAttributeNameCase`][api-element-attribute-name-case],
290-
[`Handle`][handle], [`Options`][options],
291-
[`Space`][space], and [`State`][state].
290+
[`Handle`][api-handle], [`Options`][api-options],
291+
[`Space`][api-space], and [`State`][api-state].
292292
293293
## Compatibility
294294
@@ -393,16 +393,16 @@ abide by its terms.
393393
394394
[mdx]: https://mdxjs.com
395395
396-
[defaulthandlers]: #defaulthandlers
396+
[api-default-handlers]: #defaulthandlers
397397
398-
[toestree]: #toestreetree-options
398+
[api-to-estree]: #toestreetree-options
399399
400400
[api-element-attribute-name-case]: #elementattributenamecase
401401
402-
[space]: #space
402+
[api-handle]: #handle
403403
404-
[options]: #options
404+
[api-options]: #options
405405
406-
[handle]: #handle
406+
[api-space]: #space
407407
408-
[state]: #state
408+
[api-state]: #state

0 commit comments

Comments
 (0)