@yozora/tokenizer-autolink-extension
v2.3.1
Published
<!-- :begin use tokenizer/banner -->
Downloads
73
Readme
@yozora/tokenizer-autolink-extension produce Link type nodes. See documentation for details.
Install
npm
npm install --save @yozora/tokenizer-autolink-extension
yarn
yarn add @yozora/tokenizer-autolink-extension
Usage
@yozora/tokenizer-autolink-extension has been integrated into @yozora/parser /
@yozora/parser-gfm-ex, so you can use YozoraParser
/ GfmExParser
directly.
Basic Usage
@yozora/tokenizer-autolink-extension 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 AutolinkExtensionTokenizer from '@yozora/tokenizer-autolink-extension'
const parser = new DefaultParser()
.useFallbackTokenizer(new ParagraphTokenizer())
.useFallbackTokenizer(new TextTokenizer())
.useTokenizer(new AutolinkExtensionTokenizer())
// parse source markdown content
parser.parse(`
[email protected]
http://foo.bar.baz
made-up-scheme://foo,bar
`)
Use within @yozora/parser
import YozoraParser from '@yozora/parser'
const parser = new YozoraParser()
// parse source markdown content
parser.parse(`
[email protected]
http://foo.bar.baz
made-up-scheme://foo,bar
`)
Use with @yozora/parser-gfm
import GfmParser from '@yozora/parser-gfm'
import AutolinkExtensionTokenizer from '@yozora/tokenizer-autolink-extension'
const parser = new GfmParser()
parser.useTokenizer(new AutolinkExtensionTokenizer())
// parse source markdown content
parser.parse(`
[email protected]
http://foo.bar.baz
made-up-scheme://foo,bar
`)
Use within @yozora/parser-gfm-ex
import GfmExParser from '@yozora/parser-gfm-ex'
const parser = new GfmExParser()
// parse source markdown content
parser.parse(`
[email protected]
http://foo.bar.baz
made-up-scheme://foo,bar
`)
Options
| Name | Type | Required | Default |
| :--------: | :------: | :------: | :--------------------------------------: |
| name
| string
| false
| "@yozora/tokenizer-autolink-extension"
|
| 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 thematch-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.