Skip to main content

Tiddler

tw5-typed

tw5-typed / tiddler / Tiddler

Class: Tiddler

Defined in: src/tiddler/index.d.ts:17

Constructors​

Constructor​

new Tiddler(...tiddlers): Tiddler

Defined in: src/tiddler/index.d.ts:27

Parameters​

tiddlers​

...(Tiddler | Record<string, unknown>)[]

multiple tiddler fields or instances, will merge them to create a new one

Returns​

Tiddler

Properties​

cache​

readonly cache: ITiddlerCache

Defined in: src/tiddler/index.d.ts:20

fields​

readonly fields: ITiddlerFields

Defined in: src/tiddler/index.d.ts:22

fieldModules​

static fieldModules: Record<string, IModuleInfo>

Defined in: src/tiddler/index.d.ts:18

Methods​

getFieldDay()​

getFieldDay(field): string

Defined in: src/tiddler/index.d.ts:42

Parameters​

field​

string

Returns​

string

getFieldList()​

getFieldList(field, defaultValue?): string[]

Defined in: src/tiddler/index.d.ts:46

Get the value of a field as a list

Parameters​

field​

string

defaultValue?​

string

Returns​

string[]

getFieldString()​

getFieldString(field, defaultValue?): string

Defined in: src/tiddler/index.d.ts:36

Stringify the field with the associated tiddler field module (if any)

Parameters​

field​

string

defaultValue?​

string

Returns​

string

getFieldStringBlock()​

getFieldStringBlock(options): string

Defined in: src/tiddler/index.d.ts:52

Get all the fields as a name:value block.

Parameters​

options​
exclude?​

string[]

Returns​

string

getFieldStrings()​

getFieldStrings(options?): Record<string, string>

Defined in: src/tiddler/index.d.ts:41

Get all the fields as a hashmap of strings. Options: exclude: an array of field names to exclude

Parameters​

options?​
exclude?​

string[]

Returns​

Record<string, string>

hasField()​

hasField(field): boolean

Defined in: src/tiddler/index.d.ts:30

Parameters​

field​

string

Returns​

boolean

hasTag()​

hasTag(tag): boolean

Defined in: src/tiddler/index.d.ts:29

Parameters​

tag​

string

Returns​

boolean

isDraft()​

isDraft(): boolean

Defined in: src/tiddler/index.d.ts:32

Returns​

boolean

isEqual()​

isEqual(tiddler, excludeFields?): boolean

Defined in: src/tiddler/index.d.ts:54

Parameters​

tiddler​

Tiddler

excludeFields?​

string[]

Returns​

boolean

isPlugin()​

isPlugin(): boolean

Defined in: src/tiddler/index.d.ts:31

Returns​

boolean