Token - bhsd-harry/wikiparser-node GitHub Wiki
目录
这是所有特定维基语法对应节点的父类。Token 类的父类 AstElement 是仿照 HTMLElement 类设计的。本页面仅介绍 Token 类新增的属性和方法。
展开
param: this 待替换的节点
一些具有特殊语法作用的节点只能使用这个方法替换为同类节点。注意需要使用这个方法的场合一般也需要搭配 AstNode.prototype.destroy 方法。
// safeReplaceWith (main)
var {firstChild, lastChild: {lastChild}} = Parser.parse('<p><p lang="zh">'),
attrs = lastChild.cloneNode();
assert.equal(firstChild, '<p>');
assert.equal(lastChild, ' lang="zh"');
assert.equal(attrs, ' lang="zh"');
try {
firstChild.lastChild.replaceWith(attrs);
} catch (e) {
assert.ok(e instanceof Error);
assert.equal(e.message, 'HtmlToken cannot insert child nodes!');
}
firstChild.lastChild.safeReplaceWith(attrs);展开
param: string 注释内容
returns: CommentToken
生成一个 HTML 注释。
// createComment (main)
var {firstChild} = Parser.parse('<!--a-->');
assert.equal(firstChild, '<!--a-->');
assert.deepStrictEqual(firstChild.createComment('a'), firstChild);展开
param: string 标签名
param: {closing?: boolean, selfClosing?: boolean} 选项
returns: Token
生成一个 HTML 标签或扩展标签。
// createElement (main)
var root = Parser.parse('</p><ref/>'),
{firstChild, lastChild} = root;
assert.equal(firstChild, '</p>');
assert.equal(lastChild, '<ref/>');
assert.deepStrictEqual(
root.createElement('p', {closing: true}),
firstChild,
);
assert.deepStrictEqual(
root.createElement('ref', {selfClosing: true}),
lastChild,
);展开
param: string
returns: AstText
生成一个纯文本节点。
// createTextNode (main)
var root = Parser.parse('text');
assert.deepStrictEqual(root.createTextNode('text'), root.firstChild);展开
returns: AstRange
生成一个 AstRange 对象。
// createRange (main)
var root = Parser.parse('text'),
{firstChild} = root,
range = root.createRange();
range.setStart(firstChild, 1);
range.setEnd(firstChild, 3);
assert.equal(range, 'ex');展开
param: string 链接标题
returns: RegExpExecArray | null
类似 Parser.isInterwiki 方法，但使用与当前节点相同的解析设置。
展开
returns: this
深拷贝节点。不同类型的节点采用了不同的深拷贝算法。
展开
returns: AstRange[]
获取全部章节（含序言），每个章节均是一个数组。只可用于根节点。
// sections (main)
var root = Parser.parse('a\n==b==\nc'),
[s1, s2] = root.sections(),
{childNodes: [a, b, c]} = root;
assert.equal(a, 'a\n');
assert.equal(b, '==b==');
assert.equal(c, '\nc');
assert.deepStrictEqual(s1.startContainer, root);
assert.deepStrictEqual(s1.endContainer, root);
assert.equal(s1.startOffset, 0);
assert.equal(s1.endOffset, 1);
assert.deepStrictEqual(s2.startContainer, root);
assert.deepStrictEqual(s2.endContainer, root);
assert.equal(s2.startOffset, 1);
assert.equal(s2.endOffset, 3);展开
param: number 章节序号
returns: AstRange
获取指定章节。只可用于根节点。
// section (main)
var root = Parser.parse('a\n==b==\nc'),
section = root.section(1),
{childNodes: [, b, c]} = root;
assert.equal(b, '==b==');
assert.equal(c, '\nc');
assert.deepStrictEqual(section.startContainer, root);
assert.deepStrictEqual(section.endContainer, root);
assert.equal(section.startOffset, 1);
assert.equal(section.endOffset, 3);展开
param: string HTML 标签名（可省略）
returns: [HtmlToken, HtmlToken]
获取指定的外层HTML标签。注意纯文本节点无法使用此方法。
// findEnclosingHtml (main)
var {childNodes: [start, link, end]} = Parser.parse('<p>[[a]]</p>'),
range = link.createRange();
assert.equal(start, '<p>');
assert.equal(link, '[[a]]');
assert.equal(end, '</p>');
range.setStartBefore(start);
range.setEndAfter(end);
assert.deepStrictEqual(link.findEnclosingHtml(), range);展开
returns: [string, string | undefined][]
获取全部分类及其排序关键词。
// getCategories (main)
assert.deepStrictEqual(
Parser.parse([[category:a]][[category:b|c]]').getCategories(),
[
['Category:A', undefined],
['Category:B', 'c'],
],
);展开
加入的版本：1.10.0
returns: Token
展开模板和部分魔术字。
// expand (main)
var root, copy;
Parser.templates.set(
'Template:Link_start',
`[[{{{1|<noinclude>Template:Link start]]</noinclude>}}}<noinclude>
{{doc}}</noinclude>`,
);
root = Parser.parse('{{link start|a}}b|c]]');
copy = root.expand();
assert.deepStrictEqual(copy.childNodes.map(({type}) => type), ['link']);
assert.equal(copy, '[[ab|c]]');展开
returns: Token
解析参变量和部分魔术字。
// solveConst (main)
var root = Parser.parse(
`{{{null}}}{{{|[[a]]}}}{{#if:||[//b]}}{{#switch:|#default={{c}}}}{{#switch:d|d|e=}}`,
),
copy = root.solveConst();
assert.deepStrictEqual(
copy.childNodes.map(({type}) => type),
['text', 'link', 'ext-link', 'template'],
);
assert.deepStrictEqual(
copy.childNodes.map(String),
['{{{null}}}', '[[a]]', '[//b]', '{{c}}'],
);展开
合并普通节点的普通子节点。
// flatten (main)
var root = Parser.parse(''),
plain = Parser.parse('a'),
{firstChild} = plain;
root.append(plain);
root.flatten();
assert.strictEqual(root.lastChild, firstChild);展开
加入的版本：1.10.0
param: boolean 是否禁用换行
returns: string
转换为 HTML。
// toHtml (main)
var root;
Parser.templates.set('Template:Dt', ';');
root = Parser.parse('{{dt}}{{dt}}a:b');
assert.strictEqual(
root.toHtml(),
'<dl><dt></dt>\n<dt>a</dt>\n<dd>b</dd></dl>',
);展开
加入的版本：1.17.1
构建所有 list-range 节点。
// buildLists (main)
var root = Parser.parse(';*#;a:b:c');
root.buildLists();
assert.deepStrictEqual(
root.json(),
{
range: [0, 9],
type: 'root',
childNodes: [
{
range: [0, 3],
type: 'list',
childNodes: [
{
range: [0, 3],
data: ';*#',
},
],
},
{
range: [3, 7],
type: 'list-range',
childNodes: [
{
range: [3, 4],
type: 'list',
childNodes: [
{
range: [3, 4],
data: ';',
},
],
},
{
range: [4, 5],
type: 'list-range',
childNodes: [
{
range: [4, 5],
data: 'a',
},
],
},
{
range: [5, 6],
type: 'dd',
indent: 1,
childNodes: [
{
range: [5, 6],
data: ':',
},
],
},
{
range: [6, 7],
type: 'list-range',
childNodes: [
{
range: [6, 7],
data: 'b',
},
],
},
],
},
{
range: [7, 8],
type: 'dd',
indent: 1,
childNodes: [
{
range: [7, 8],
data: ':',
},
],
},
{
range: [8, 9],
type: 'list-range',
childNodes: [
{
range: [8, 9],
data: 'c',
},
],
},
],
},
);