CategoryToken (EN)

• Introduction
• Properties
  • type ✅
  • sortkey
• Methods
  • cloneNode
  • setSortkey
  • toHtml

Other Languages

• 简体中文

Introduction

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

✅ Available in the Mini and Browser versions.

Properties

type

✅ Expand

type: 'category'

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

sortkey

Expand

type: string
Sort key.

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

Methods

cloneNode

Expand

returns: this
Deep clone the node.

// cloneNode (main)
var {firstChild} = Parser.parse('[[category:a#b|c]]');
assert.deepStrictEqual(firstChild.cloneNode(), firstChild);

setSortkey

Expand

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

toHtml

Expand

version added: 1.10.0

returns: string
Convert to HTML.

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