@yozora/tokenizer-break
TypeScript icon, indicating that this package has built-in type declarations

2.3.1 • Public • Published

@yozora/tokenizer-break


@yozora/tokenizer-break produce Break type nodes. See documentation for details.

Install

  • npm

    npm install --save @yozora/tokenizer-break
  • yarn

    yarn add @yozora/tokenizer-break

Usage

@yozora/tokenizer-break has been integrated into @yozora/parser / @yozora/parser-gfm-ex / @yozora/parser-gfm, so you can use YozoraParser / GfmExParser / GfmParser directly.

Basic Usage

@yozora/tokenizer-break cannot be used alone, it needs to be registered in YastParser as a plugin-in before it can be used.

import { DefaultParser } from '@yozora/core-parser'
import ParagraphTokenizer from '@yozora/tokenizer-paragraph'
import TextTokenizer from '@yozora/tokenizer-text'
import BreakTokenizer from '@yozora/tokenizer-break'

const parser = new DefaultParser()
  .useFallbackTokenizer(new ParagraphTokenizer())
  .useFallbackTokenizer(new TextTokenizer())
  .useTokenizer(new BreakTokenizer())

// parse source markdown content
parser.parse(`
foo
baz

foo\
baz

foo
baz
`)

Use within @yozora/parser

import YozoraParser from '@yozora/parser'

const parser = new YozoraParser()

// parse source markdown content
parser.parse(`
foo
baz

foo\
baz

foo
baz
`)

Use with @yozora/parser-gfm

import GfmParser from '@yozora/parser-gfm'

const parser = new GfmParser()

// parse source markdown content
parser.parse(`
foo
baz

foo\
baz

foo
baz
`)

Use within @yozora/parser-gfm-ex

import GfmExParser from '@yozora/parser-gfm-ex'

const parser = new GfmExParser()

// parse source markdown content
parser.parse(`
foo
baz

foo\
baz

foo
baz
`)

Options

Name Type Required Default
name string false "@yozora/tokenizer-break"
priority number false TokenizerPriority.ATOMIC
  • name: The unique name of the tokenizer, used to bind the token it generates, to determine the tokenizer that should be called in each life cycle of the token in the entire matching / parsing phase.

  • priority: Priority of the tokenizer, determine the order of processing, high priority priority execution. interruptable. In addition, in the match-block stage, a high-priority tokenizer can interrupt the matching process of a low-priority tokenizer.

    Exception: Delimiters of type full are always processed before other type delimiters.

Related

Readme

Keywords

none

Package Sidebar

Install

npm i @yozora/tokenizer-break

Weekly Downloads

0

Version

2.3.1

License

MIT

Unpacked Size

55.1 kB

Total Files

8

Last publish

Collaborators

  • lemonclown