Skip to content

Commit

Permalink
Refactor
Browse files Browse the repository at this point in the history
  • Loading branch information
wooorm committed Nov 12, 2021
1 parent 5ff5ee4 commit 901a104
Show file tree
Hide file tree
Showing 2 changed files with 11 additions and 11 deletions.
18 changes: 9 additions & 9 deletions dev/lib/index.js
Expand Up @@ -31,7 +31,7 @@
* @typedef {import('mdast').Text} Text
* @typedef {import('mdast').ThematicBreak} ThematicBreak
*
* @typedef {UnistParent & {type: 'fragment', children: PhrasingContent[]}} Fragment
* @typedef {UnistParent & {type: 'fragment', children: Array<PhrasingContent>}} Fragment
*/

/**
Expand All @@ -50,14 +50,14 @@
* @typedef {(this: CompileContext, token: Token) => void} Handle
* @typedef {Record<string, Handle>} Handles
* Token types mapping to handles
* @typedef {Record<string, Record<string, unknown>|Array.<unknown>> & {canContainEols: Array.<string>, transforms: Array.<Transform>, enter: Handles, exit: Handles}} NormalizedExtension
* @typedef {Record<string, Record<string, unknown>|Array<unknown>> & {canContainEols: Array<string>, transforms: Array<Transform>, enter: Handles, exit: Handles}} NormalizedExtension
* @typedef {Partial<NormalizedExtension>} Extension
* An mdast extension changes how markdown tokens are turned into mdast.
*
* @typedef CompileContext
* mdast compiler context
* @property {Array.<Node | Fragment>} stack
* @property {Array.<Token>} tokenStack
* @property {Array<Node | Fragment>} stack
* @property {Array<Token>} tokenStack
* @property {(key: string, value?: unknown) => void} setData
* Set data into the key-value store.
* @property {<K extends string>(key: K) => CompileData[K]} getData
Expand All @@ -75,7 +75,7 @@
* @property {NormalizedExtension} config
* Configuration.
*
* @typedef {{mdastExtensions?: Array.<Extension|Array.<Extension>>}} FromMarkdownOptions
* @typedef {{mdastExtensions?: Array<Extension|Array<Extension>>}} FromMarkdownOptions
* @typedef {ParseOptions & FromMarkdownOptions} Options
*/

Expand Down Expand Up @@ -249,7 +249,7 @@ function compiler(options = {}) {
return compile

/**
* @param {Array.<Event>} events
* @param {Array<Event>} events
* @returns {Root}
*/
function compile(events) {
Expand All @@ -259,7 +259,7 @@ function compiler(options = {}) {
const stack = [tree]
/** @type {CompileContext['tokenStack']} */
const tokenStack = []
/** @type {Array.<number>} */
/** @type {Array<number>} */
const listStack = []
/** @type {Omit<CompileContext, 'sliceSerialize'>} */
const context = {
Expand Down Expand Up @@ -342,7 +342,7 @@ function compiler(options = {}) {
}

/**
* @param {Array.<Event>} events
* @param {Array<Event>} events
* @param {number} start
* @param {number} length
* @returns {number}
Expand Down Expand Up @@ -1095,7 +1095,7 @@ function compiler(options = {}) {

/**
* @param {Extension} combined
* @param {Array.<Extension|Array.<Extension>>} extensions
* @param {Array<Extension|Array<Extension>>} extensions
* @returns {Extension}
*/
function configure(combined, extensions) {
Expand Down
4 changes: 2 additions & 2 deletions readme.md
Expand Up @@ -97,12 +97,12 @@ Value to parse (`string` or [`Buffer`][buffer]).

###### `options.extensions`

Array of syntax extensions (`Array.<MicromarkSyntaxExtension>`, default: `[]`).
Array of syntax extensions (`Array<MicromarkSyntaxExtension>`, default: `[]`).
Passed to [`micromark` as `extensions`][micromark-extensions].

###### `options.mdastExtensions`

Array of mdast extensions (`Array.<MdastExtension>`, default: `[]`).
Array of mdast extensions (`Array<MdastExtension>`, default: `[]`).

##### Returns

Expand Down

0 comments on commit 901a104

Please sign in to comment.