micromark-factory-space

[![Build][build-badge]][build]
[![Coverage][coverage-badge]][coverage]
[![Downloads][downloads-badge]][downloads]
[![Size][bundle-size-badge]][bundle-size]
[![Sponsors][sponsors-badge]][opencollective]
[![Backers][backers-badge]][opencollective]
[![Chat][chat-badge]][chat]

[micromark][] factory to parse [markdown space][markdown-space] (found in lots
of places).

Contents

* What is this?
* When should I use this?
* Install
* Use
* API
* factorySpace(…)
* Types
* Compatibility
* Security
* Contribute
* License

What is this?

This package exposes states to parse spaces and/or tabs.

When should I use this?

This package is useful when you are making your own micromark extensions.

Install

This package is [ESM only][esm].
In Node.js (version 16+), install with [npm][]:

``sh
npm install micromark-factory-space
`

In Deno with [esm.sh][esmsh]:

`js
import {factorySpace} from 'https://esm.sh/micromark-factory-space@1'
`

In browsers with [esm.sh][esmsh]:

`html

`

Use

`js
import {factorySpace} from 'micromark-factory-space'
import {codes, types} from 'micromark-util-symbol'

// A micromark tokenizer that uses the factory:
/**
* @this {TokenizeContext}
* Context.
* @type {Tokenizer}
*/
function tokenizeCodeFenced(effects, ok, nok) {
return start

// …

/* @type {State} /
function info(code) {
if (code === codes.eof || markdownLineEndingOrSpace(code)) {
effects.exit(types.chunkString)
effects.exit(types.codeFencedFenceInfo)
return factorySpace(effects, infoAfter, types.whitespace)(code)
}

if (code === codes.graveAccent && code === marker) return nok(code)
effects.consume(code)
return info
}

// …
}
`

API

This module exports the identifier [factorySpace][api-factory-space].
There is no default export.

$3

Parse spaces and tabs.

There is no nok parameter:

* spaces in markdown are often optional, in which case this factory can be
used and ok will be switched to whether spaces were found or not
* one line ending or space can be detected with markdownSpace(code) right
before using factorySpace

###### Examples

Where ␉ represents a tab (plus how much it expands) and ␠ represents a
single space.

`markdown
␉
␠␠␠␠
␉␠
`

###### Parameters

* effects (Effects)
— context
* ok (State)
— state switched to when successful
* type (string)
— type (' \t')
* max (number, default: Infinity)
— max (exclusive)

###### Returns

Start state (State).

Types

This package is fully typed with [TypeScript][].
It exports no additional types.

Compatibility

Projects maintained by the unified collective are compatible with maintained
versions of Node.js.

When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line,
micromark-factory-space@2, compatible with Node.js 16.
This package works with micromark@3.

Security

This package is safe.
See [security.md][securitymd] in [micromark/.github][health] for how to
submit a security report.

Contribute

See [contributing.md][contributing] in [micromark/.github][health] for ways
to get started.
See [support.md`][support] for ways to get help.

This project has a [code of conduct][coc].
By interacting with this repository, organisation, or community you agree to
abide by its terms.

License

[MIT][license] © [Titus Wormer][author]

[build-badge]: https://github.com/micromark/micromark/workflows/main/badge.svg

[build]: https://github.com/micromark/micromark/actions

[coverage-badge]: https://img.shields.io/codecov/c/github/micromark/micromark.svg

[coverage]: https://codecov.io/github/micromark/micromark

[downloads-badge]: https://img.shields.io/npm/dm/micromark-factory-space.svg

[downloads]: https://www.npmjs.com/package/micromark-factory-space

[bundle-size-badge]: https://img.shields.io/badge/dynamic/json?label=minzipped%20size&query=$.size.compressedSize&url=https://deno.bundlejs.com/?q=micromark-factory-space

[bundle-size]: https://bundlejs.com/?q=micromark-factory-space

[sponsors-badge]: https://opencollective.com/unified/sponsors/badge.svg

[backers-badge]: https://opencollective.com/unified/backers/badge.svg

[opencollective]: https://opencollective.com/unified

[npm]: https://docs.npmjs.com/cli/install

[esm]: https://gist.github.com/sindresorhus/a39789f98801d908bbc7ff3ecc99d99c

[esmsh]: https://esm.sh

[chat-badge]: https://img.shields.io/badge/chat-discussions-success.svg

[chat]: https://github.com/micromark/micromark/discussions

[license]: https://github.com/micromark/micromark/blob/main/license

[author]: https://wooorm.com

[health]: https://github.com/micromark/.github

[securitymd]: https://github.com/micromark/.github/blob/main/security.md

[contributing]: https://github.com/micromark/.github/blob/main/contributing.md

[support]: https://github.com/micromark/.github/blob/main/support.md

[coc]: https://github.com/micromark/.github/blob/main/code-of-conduct.md

[markdown-space]: https://github.com/micromark/micromark/tree/main/packages/micromark-util-character#markdownspacecode

[typescript]: https://www.typescriptlang.org

[micromark]: https://github.com/micromark/micromark

[api-factory-space]: #factoryspace