CategoryToken (EN)

• Introduction
• Properties
  • sortkey 🌐
  • type ✅
• Methods
  • json 🌐
  • setSortkey

Other Languages

• 简体中文

Introduction

Category. This class inherits all the properties and methods of the LinkBaseToken class which are not repeated here.

✅ Available in the Mini and Browser versions.
🌐 Available in the Browser version.

Properties

sortkey

🌐 Expand

type: string
Sort key.

// sortkey (print)
var {firstChild} = Parser.parse('[[category:a|<|]]]');
assert.strictEqual(firstChild.sortkey, '<|]');

// sortkey (main)
var {firstChild} = Parser.parse('[[category:a]]');
firstChild.sortkey = 'b';
assert.equal(firstChild, '[[category:a|b]]');
firstChild.sortkey = undefined;
assert.equal(firstChild, '[[category:a]]');

type

✅ Expand

type: 'category'

// type
var {firstChild} = Parser.parse('[[category:a]]');
assert.strictEqual(firstChild.type, 'category');

Methods

json

🌐 Expand

Save the syntax tree as JSON.

// json
var {lastChild} = Parser.parse(' [[category:a| ]]');
assert.deepStrictEqual(lastChild.json(), {
	range: [1, 17],
	type: 'category',
	name: 'Category:A',
	sortkey: ' ',
	childNodes: [
		{
			range: [3, 13],
			type: 'link-target',
			childNodes: [
				{
					range: [3, 13],
					data: 'category:a',
				},
			],
		},
		{
			range: [14, 15],
			type: 'link-text',
			childNodes: [
				{
					range: [14, 15],
					data: ' ',
				},
			],
		},
	],
});

setSortkey

Expand

param: string sort key
Set the sort key. Alias of LinkBaseToken.prototype.setLinkText.