Wiki
Class: Wiki
Defined in: src/modules/wiki.d.ts:29
Constructors
Constructor
new Wiki(
options):Wiki
Defined in: src/modules/wiki.d.ts:36
Wiki constructor. State is stored in private members that only a small number of privileged accessor methods have direct access. Methods added via the prototype have to use these accessors and cannot access the state data directly.
Parameters
options
options include:
- enableIndexers - Array of indexer names to enable, or null to use all available indexers
enableIndexers
unknown[]
Returns
Wiki
Memberof
Wiki
Methods
addEventListener()
Call Signature
addEventListener(
type,handler):void
Defined in: src/modules/wiki.d.ts:632
Parameters
type
string
handler
(event) => void | Promise<void>
Returns
void
Call Signature
addEventListener(
type,handler):void
Defined in: src/modules/wiki.d.ts:636
Parameters
type
"change"
handler
(change) => void | Promise<void>
Returns
void
Call Signature
addEventListener(
type,handler):void
Defined in: src/modules/wiki.d.ts:640
Parameters
type
"lazyLoad"
handler
(title) => void | Promise<void>
Returns
void
addIndexer()
addIndexer(
indexer,name):void
Defined in: src/modules/wiki.d.ts:37
Parameters
indexer
unknown
name
string
Returns
void
addIndexersToWiki()
addIndexersToWiki():
void
Defined in: src/modules/wiki.d.ts:625
Add indexers to this wiki (internal method)
Returns
void
addTiddler()
addTiddler(
tiddler):void
Defined in: src/modules/wiki.d.ts:230
Create or update tiddler. Update existed tiddler based on the title field.
Parameters
tiddler
Tiddler | Partial<ITiddlerFields> | Partial<ITiddlerFieldsParameter>
Returns
void
addTiddlers()
addTiddlers(
tiddler):void
Defined in: src/modules/wiki.d.ts:236
Call addTiddler for each iton of the list, but should passing tiddler.fields, directly passing tiddler object may failed to add in some cases.
Parameters
tiddler
(Partial<ITiddlerFields> | Partial<ITiddlerFieldsParameter>)[]
Returns
void
addToHistory()
addToHistory(
title,fromPageRect?,historyTitle?):void
Defined in: src/modules/wiki.d.ts:517
Add a new record to the top of the history stack
Parameters
title
A title string or an array of title strings
string | string[]
fromPageRect?
unknown
Page coordinates of the origin of the navigation
historyTitle?
string
Title of history tiddler (defaults to $:/HistoryList)
Returns
void
Deprecated
Use story.addToHistory() from the story object instead
addToStory()
addToStory(
title,fromTitle?,storyTitle?,options?):void
Defined in: src/modules/wiki.d.ts:509
Add a new tiddler to the story river
Parameters
title
A title string or an array of title strings
string | string[]
fromTitle?
string
The title of the tiddler from which the navigation originated
storyTitle?
string
Title of story tiddler (defaults to $:/StoryList)
options?
Additional options
openLinkFromInsideRiver?
boolean
openLinkFromOutsideRiver?
boolean
Returns
void
Deprecated
Use story.addToStory() from the story object instead
checkTiddlerText()
checkTiddlerText(
title,targetText,options?):boolean
Defined in: src/modules/wiki.d.ts:112
Check whether the text of a tiddler matches a given value
Parameters
title
string
Tiddler title
targetText
string
Text to compare with
options?
Comparison options
caseSensitive?
boolean
noTrim?
boolean
Returns
boolean
clearCache()
clearCache(
title?):void
Defined in: src/modules/wiki.d.ts:175
Clear all caches associated with a particular tiddler, or if the title is null, clear all caches for all tiddlers
Parameters
title?
string
Tiddler title or null to clear all caches
Returns
void
clearGlobalCache()
clearGlobalCache():
void
Defined in: src/modules/wiki.d.ts:170
clear all cache, will be called when a tiddler is changed
Returns
void
clearTiddlerEventQueue()
clearTiddlerEventQueue():
void
Defined in: src/modules/wiki.d.ts:609
Clear the tiddler event queue
Returns
void
compileFilter()
compileFilter(
filterString): (source?,widget?) =>string[]
Defined in: src/modules/wiki.d.ts:184
Compile filter string to be a function that execute the filter in the wiki. You can pass an optional iterator that provide the input to the returned function. If no iterator is provided, filter will use first operator to get input.
Parameters
filterString
string
Returns
a function with the signature fn(source,widget) where: source: an iterator function for the source tiddlers, called source(iterator), where iterator is called as iterator(tiddler,title) widget: an optional widget node for retrieving the current tiddler etc.
(
source?,widget?):string[]
Parameters
source?
string[] | Record<string, unknown> | (iterator) => void
widget?
Returns
string[]
countTiddlers()
countTiddlers(
excludeTag?):number
Defined in: src/modules/wiki.d.ts:149
Count the number of tiddlers in the wiki
Parameters
excludeTag?
string
Optional tag to exclude from the count
Returns
number
deleteTextReference()
deleteTextReference(
textReference,currentTiddlerTitle?):void
Defined in: src/modules/wiki.d.ts:144
Delete a text reference
Parameters
textReference
string
currentTiddlerTitle?
string
Returns
void
deleteTiddler()
deleteTiddler(
title):void
Defined in: src/modules/wiki.d.ts:56
Parameters
title
string
Returns
void
deserializeTiddlers()
deserializeTiddlers(
type,text,sourceFields?,options?):ITiddlerFieldsParameter[]
Defined in: src/modules/wiki.d.ts:325
Extracts tiddlers from a typed block of text, specifying default field values
Parameters
type
string
text
string
sourceFields?
options?
Returns
dispatchEvent()
Call Signature
dispatchEvent(
type,dataOrEvent):void
Defined in: src/modules/wiki.d.ts:645
Parameters
type
string
dataOrEvent
unknown
Returns
void
Call Signature
dispatchEvent(
type,change):void
Defined in: src/modules/wiki.d.ts:649
Parameters
type
"change"
change
Returns
void
Call Signature
dispatchEvent(
type,title):void
Defined in: src/modules/wiki.d.ts:653
Parameters
type
"lazyLoad"
title
string
Returns
void
doesPluginInfoRequireReload()
doesPluginInfoRequireReload(
pluginInfo):boolean
Defined in: src/modules/wiki.d.ts:544
Determine whether a plugin info structure is dynamically loadable
Parameters
pluginInfo
Plugin info object
Returns
boolean
doesPluginRequireReload()
doesPluginRequireReload(
title):boolean
Defined in: src/modules/wiki.d.ts:539
Determine whether a plugin by title is dynamically loadable
Parameters
title
string
Plugin title
Returns
boolean
each()
each(
callback):void
Defined in: src/modules/wiki.d.ts:57
Parameters
callback
(tiddler, title) => void
Returns
void
enqueueTiddlerEvent()
enqueueTiddlerEvent(
title,isDeleted?,isShadow?):void
Defined in: src/modules/wiki.d.ts:616
Enqueue a tiddler event (internal method)
Parameters
title
string
Tiddler title
isDeleted?
boolean
Whether the tiddler was deleted
isShadow?
boolean
Whether this is a shadow tiddler change
Returns
void
extractLinks()
extractLinks(
parseTreeRoot):string[]
Defined in: src/modules/wiki.d.ts:423
Return an array of tiddler titles that are directly linked within the given parse tree
Parameters
parseTreeRoot
The parse tree root node
Returns
string[]
extractTranscludes()
extractTranscludes(
parseTreeRoot,title?):string[]
Defined in: src/modules/wiki.d.ts:429
Return an array of tiddler titles that are directly transcluded within the given parse tree
Parameters
parseTreeRoot
The parse tree root node
title?
string
The tiddler being parsed (to ignore self-referential transclusions)
Returns
string[]
filterTiddlers()
filterTiddlers(
filterString,widget?,source?):string[]
Defined in: src/modules/wiki.d.ts:211
You can use this with makeTiddlerIterator:
$tw.wiki.filterTiddlers(filter, undefined, $tw.wiki.makeTiddlerIterator(['title']))
This calls compileFilter
Parameters
filterString
string
widget?
source?
Returns
string[]
findDraft()
findDraft(
targetTitle):string
Defined in: src/modules/wiki.d.ts:495
Find any existing draft of a specified tiddler
Parameters
targetTitle
string
Title of the target tiddler
Returns
string
findListingsOfTiddler()
findListingsOfTiddler(
targetTitle,fieldName?):string[]
Defined in: src/modules/wiki.d.ts:445
Lookup a given tiddler and return a list of all the tiddlers that include it in the specified list field
Parameters
targetTitle
string
Target tiddler title
fieldName?
string
Field name (defaults to "list")
Returns
string[]
forEachTiddler()
Call Signature
forEachTiddler(
options,callback):void
Defined in: src/modules/wiki.d.ts:63
For every tiddler invoke a callback(title,tiddler) with this set to the wiki object.
Parameters
options
Options include sortField, excludeTag, includeSystem
excludeTag?
string
includeSystem?
boolean
sortField?
string
callback
(title, tiddler) => void
Function to be called for each tiddler
Returns
void
Call Signature
forEachTiddler(
callback):void
Defined in: src/modules/wiki.d.ts:64
For every tiddler invoke a callback(title,tiddler) with this set to the wiki object.
Parameters
callback
(title, tiddler) => void
Function to be called for each tiddler
Returns
void
generateDraftTitle()
generateDraftTitle(
title):string
Defined in: src/modules/wiki.d.ts:522
Generate a draft title for a given tiddler
Parameters
title
string
Title of the tiddler to create a draft for
Returns
string
generateNewTitle()
generateNewTitle(
baseTitle,options):string
Defined in: src/modules/wiki.d.ts:452
Generate an unused title from the specified base options.prefix must be a string
Parameters
baseTitle
string
options
prefix?
string
Returns
string
getCacheForTiddler()
getCacheForTiddler<
T>(title,cacheName,initializer):T
Defined in: src/modules/wiki.d.ts:162
Return the named cache object for a tiddler. If the cache doesn't exist then the initializer function is invoked to create it
Type Parameters
T
T
Parameters
title
string
cacheName
string
key of the cache
initializer
() => T
when cache miss, this will be called to get initial value
Returns
T
getChangeCount()
getChangeCount(
title):number
Defined in: src/modules/wiki.d.ts:447
Parameters
title
string
Returns
number
getCreationFields()
getCreationFields():
object
Defined in: src/modules/wiki.d.ts:465
Return a hashmap of the fields that should be set when a tiddler is created
Returns
object
created?
optionalcreated:Date
creator?
optionalcreator:string
getGlobalCache()
getGlobalCache<
T>(cacheName,initializer):T
Defined in: src/modules/wiki.d.ts:156
Return a named global cache object. Global cache objects are cleared whenever a tiddler change. You can put anything into the cache.
Type Parameters
T
T
Parameters
cacheName
string
key of the cache
initializer
() => T
when cache miss, this will be called to get initial value
Returns
T
getMissingTitles()
getMissingTitles():
string[]
Defined in: src/modules/wiki.d.ts:476
Returns
string[]
getModificationFields()
getModificationFields():
object
Defined in: src/modules/wiki.d.ts:470
Return a hashmap of the fields that should be set when a tiddler is modified.
This is used for generating modified field when modify tiddler using actions like action-setmultiplefields
Returns
object
modified?
optionalmodified:Date
modifier?
optionalmodifier:string
getOrphanTitles()
getOrphanTitles():
string[]
Defined in: src/modules/wiki.d.ts:480
Return an array of tiddler titles that are not linked from any other tiddler
Returns
string[]
getPluginInfo()
getPluginInfo(
title):object
Defined in: src/modules/wiki.d.ts:446
Parameters
title
string
Returns
object
tiddlers
tiddlers:
Record<string,ITiddlerFields>
getShadowSource()
getShadowSource(
title):string
Defined in: src/modules/wiki.d.ts:416
return shadowTiddlers[title].source;
Parameters
title
string
Returns
string
getSizeOfTiddlerEventQueue()
getSizeOfTiddlerEventQueue():
number
Defined in: src/modules/wiki.d.ts:605
Get the size of tiddler event queue
Returns
number
getSubstitutedText()
getSubstitutedText(
text,widget,options?):string
Defined in: src/modules/wiki.d.ts:580
Get substituted text with variable and filter replacements
Parameters
text
string
Text to perform substitutions on
widget
Widget for context
options?
Options including substitutions array
substitutions?
object[]
Returns
string
getSubTiddler()
getSubTiddler(
title,subTiddlerTitle):Tiddler
Defined in: src/modules/wiki.d.ts:458
Get a subtiddler from a plugin or data tiddler
Parameters
title
string
Title of the plugin or data tiddler
subTiddlerTitle
string
Title of the subtiddler within the bundle
Returns
getTagMap()
getTagMap():
Record<string,string[]>
Defined in: src/modules/wiki.d.ts:490
Get a hashmap by tag of arrays of tiddler titles
Returns
Record<string, string[]>
getTextReference()
getTextReference(
textReference,defaultText?,currentTiddlerTitle?):string
Defined in: src/modules/wiki.d.ts:131
Get the value of a text reference. Text references can have any of these forms:
tiddlertitletiddlertitle!!fieldname!!fieldname- specifies a field of the current tiddlerstiddlertitle##index
Parameters
textReference
string
defaultText?
string
Default text to return if the reference is not found
currentTiddlerTitle?
string
Returns
string
getTextReferenceParserInfo()
getTextReferenceParserInfo(
title,field?,index?,options?):object
Defined in: src/modules/wiki.d.ts:588
Parse a text reference and get parser info
Parameters
title
string
Title of tiddler
field?
string
Field name
index?
string
Index name
options?
Options including subTiddler and defaultType
defaultType?
string
subTiddler?
string
Returns
object
parserType
parserType:
string
sourceText
sourceText:
string
getTiddler()
getTiddler(
title):Tiddler
Defined in: src/modules/wiki.d.ts:38
Parameters
title
string
Returns
getTiddlerAsJson()
getTiddlerAsJson(
title):string
Defined in: src/modules/wiki.d.ts:55
Get JSON string of tiddler. Note that this will make lists like tags/list to be string, instead of array. And result is a string, not an object.
Parameters
title
string
Returns
string
a stringified JSON with type ITiddlerJSONResult. You will need to use JSON.parse on it.
getTiddlerBacklinks()
getTiddlerBacklinks(
targetTitle):string[]
Defined in: src/modules/wiki.d.ts:417
Parameters
targetTitle
string
Returns
string[]
getTiddlerBacktranscludes()
getTiddlerBacktranscludes(
targetTitle):string[]
Defined in: src/modules/wiki.d.ts:439
Return an array of tiddler titles that transclude to the specified tiddler
Parameters
targetTitle
string
Target tiddler title
Returns
string[]
getTiddlerData()
getTiddlerData<
D>(titleOrTiddler,fallbackData?):D
Defined in: src/modules/wiki.d.ts:261
Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
application/json: the tiddler JSON is parsed into an object application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
Other types currently just return undefined or as same as fallbackData.
titleOrTiddler: string tiddler title or a tiddler object defaultData: default data to be returned if the tiddler is missing or doesn't contain data
Alternative, uncached version of getTiddlerDataCached(). The return value can be mutated freely and reused
Type Parameters
D
D extends unknown[] | Record<string, unknown>
Parameters
titleOrTiddler
string | Tiddler
fallbackData?
D
Returns
D
getTiddlerDataCached()
getTiddlerDataCached<
D>(titleOrTiddler,fallbackData?):D
Defined in: src/modules/wiki.d.ts:280
D is any JSON, like JSON object or JSON array
Get the content of a tiddler as a JavaScript object. How this is done depends on the type of the tiddler:
application/json: the tiddler JSON is parsed into an object application/x-tiddler-dictionary: the tiddler is parsed as sequence of name:value pairs
Other types currently just return undefined or as same as fallbackData.
titleOrTiddler: string tiddler title or a tiddler object defaultData: default data to be returned if the tiddler is missing or doesn't contain data
Note that the same value is returned for repeated calls for the same tiddler data. The value is frozen to prevent modification; otherwise modifications would be visible to all callers
Type Parameters
D
D
Parameters
titleOrTiddler
string | Tiddler
fallbackData?
D
Returns
D
getTiddlerLinks()
getTiddlerLinks(
title):string[]
Defined in: src/modules/wiki.d.ts:418
Parameters
title
string
Returns
string[]
getTiddlerList()
getTiddlerList(
title,field?,index?):string[]
Defined in: src/modules/wiki.d.ts:120
Return the content of a tiddler as an array containing each line
Parameters
title
string
Title of the tiddler
field?
string
Field name (defaults to "list")
index?
string
Data index (key) to get, if you are getting a JSON data tiddler
Returns
string[]
Array of strings parsed from the field/index value
getTiddlers()
getTiddlers():
string[]
Defined in: src/modules/wiki.d.ts:42
Get full list of tiddler titles in the wiki
Returns
string[]
getTiddlersAsJson()
getTiddlersAsJson(
filter,spaces?):string
Defined in: src/modules/wiki.d.ts:49
Get JSON string of tiddlers. Note that this will make lists like tags/list to be string, instead of array. And result is a string, not an array.
Parameters
filter
string
Filter string
spaces?
string
Last arg of JSON.stringify, default is ' '
Returns
string
a stringified JSON with type ITiddlerJSONResult. You will need to use JSON.parse on it.
getTiddlersWithTag()
getTiddlersWithTag(
tag):string[]
Defined in: src/modules/wiki.d.ts:474
Retrieves a list of the tiddler titles that are tagged with a given tag
Parameters
tag
string
Returns
string[]
getTiddlerText()
Call Signature
getTiddlerText(
title,fallbackText):string
Defined in: src/modules/wiki.d.ts:246
Get tiddler's text field, with an optional default text. If have _is_skinny field, will just return null (this is a rare case, so not put in the return type for now).
Parameters
title
string
will return undefined (or fallback) if the tiddler isn't found
fallbackText
string
default text when text field is empty or undefined
Returns
string
Call Signature
getTiddlerText(
title,fallbackText?):string
Defined in: src/modules/wiki.d.ts:247
Get tiddler's text field, with an optional default text. If have _is_skinny field, will just return null (this is a rare case, so not put in the return type for now).
Parameters
title
string
will return undefined (or fallback) if the tiddler isn't found
fallbackText?
string
default text when text field is empty or undefined
Returns
string
getTiddlerTranscludes()
getTiddlerTranscludes(
title):string[]
Defined in: src/modules/wiki.d.ts:434
Return an array of tiddler titles that are transcluded from the specified tiddler
Parameters
title
string
Tiddler title
Returns
string[]
importTiddler()
importTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:414
Like addTiddler() except it will silently reject any plugin tiddlers that are older than the currently loaded version. Returns true if the tiddler was imported
Parameters
title
string
Returns
boolean
initParsers()
initParsers(
moduleType?):void
Defined in: src/modules/wiki.d.ts:621
Initialize parsers (internal method)
Parameters
moduleType?
string
Module type
Returns
void
invokeActionString()
invokeActionString(
actions,event?,variables?,options?):void
Defined in: src/modules/wiki.d.ts:552
Execute an action string without an associated context widget
Parameters
actions
string
Action string to execute
event?
Event object
variables?
Record<string, string>
Variables hashmap
options?
Options including parentWidget
parentWidget?
Returns
void
invokeUpgraders()
invokeUpgraders(
titles,tiddlers):Record<string,string>
Defined in: src/modules/wiki.d.ts:534
Invoke the available upgrader modules
Parameters
titles
string[]
Array of tiddler titles to be processed
tiddlers
Record<string, ITiddlerFields>
Hashmap by title of tiddler fields of pending import tiddlers
Returns
Record<string, string>
isBinaryTiddler()
isBinaryTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:406
Parameters
title
string
Returns
boolean
isDraftModified()
isDraftModified(
title):boolean
Defined in: src/modules/wiki.d.ts:500
Check whether the specified draft tiddler has been modified
Parameters
title
string
Title of the draft tiddler
Returns
boolean
isImageTiddler()
isImageTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:407
Parameters
title
string
Returns
boolean
isShadowTiddler()
isShadowTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:405
Determines if a tiddler is a shadow tiddler, regardless of whether it has been overridden by a real tiddler
Parameters
title
string
Returns
boolean
isSystemTiddler()
isSystemTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:408
Parameters
title
string
Returns
boolean
isTemporaryTiddler()
isTemporaryTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:409
Parameters
title
string
Returns
boolean
isVolatileTiddler()
isVolatileTiddler(
title):boolean
Defined in: src/modules/wiki.d.ts:410
Parameters
title
string
Returns
boolean
makeTiddlerIterator()
makeTiddlerIterator(
titles):SourceIterator
Defined in: src/modules/wiki.d.ts:198
Returns a function iterator(callback) that iterates through the specified titles, and invokes the callback with callback(tiddler,title)
Parameters
titles
string[]
Returns
makeTranscludeWidget()
makeTranscludeWidget(
title,options):Widget
Defined in: src/modules/wiki.d.ts:385
Make a widget tree for transclusion
Parameters
title
string
options
object & IMakeWidgetOptions
Returns
Params
title: target tiddler title
Params
options: as for wiki.makeWidget() plus:
- options.field: optional field to transclude (defaults to "text")
- options.mode: transclusion mode "inline" or "block"
- options.recursionMarker : optional flag to set a recursion marker, defaults to "yes"
- options.children: optional array of children for the transclude widget
- options.importVariables: optional importvariables filter string for macros to be included
- options.importPageMacros: optional boolean; if true, equivalent to passing "[[$:/core/ui/PageMacros]] [all[shadows+tiddlers]tag[$:/tags/Macro]!has[draft.of]]" to options.importVariables
makeWidget()
makeWidget(
parser,options?):Widget
Defined in: src/modules/wiki.d.ts:369
Make a widget tree for a parse tree
Parameters
parser
tree
options?
Returns
Params
parser: parser object
Params
options: see below Options include: document: optional document to use variables: hashmap of variables to set parentWidget: optional parent widget for the root node
parseFilter()
parseFilter(
filter):FilterParseTreeNode[]
Defined in: src/modules/parsers/index.d.ts:186
Parse a filter string
Parameters
filter
string
Returns
parseText()
parseText(
type,text,options?):WikiParser
Defined in: src/modules/wiki.d.ts:314
Parse a block of text of a specified MIME type
Parameters
type
string
text
string
options?
Returns
parseTextReference()
parseTextReference(
title,field?,index?,options?):WikiParser
Defined in: src/modules/wiki.d.ts:601
Parse a text reference
Parameters
title
string
Title of tiddler
field?
string
Field name
index?
string
Index name
options?
Parse options
Returns
parseTiddler()
parseTiddler(
title,options?):WikiParser
Defined in: src/modules/wiki.d.ts:303
Parse a tiddler according to its MIME type
Parameters
title
string
options?
Returns
readFile()
readFile(
file,options?):void
Defined in: src/modules/wiki.d.ts:564
Read a browser File object
Parameters
file
File
File object
options?
Options or callback function
{ callback?: (tiddlerFieldsArray) => void; deserializer?: string; } | (tiddlerFieldsArray) => void
Returns
void
readFileContent()
readFileContent(
file,type,isBinary,deserializer,callback):void
Defined in: src/modules/wiki.d.ts:573
Lower level utility to read the content of a browser File object
Parameters
file
File
File object
type
string
MIME type
isBinary
boolean
Whether the file is binary
deserializer
string
Deserializer name
callback
(tiddlerFieldsArray) => void
Callback function
Returns
void
readFiles()
readFiles(
files,options?):number
Defined in: src/modules/wiki.d.ts:558
Read an array of browser File objects
Parameters
files
File[]
Array of File objects
options?
Options or callback function
{ callback?: (tiddlerFieldsArray) => void; } | (tiddlerFieldsArray) => void
Returns
number
removeEventListener()
removeEventListener(
type,handler):void
Defined in: src/modules/wiki.d.ts:627
Parameters
type
string
handler
(event) => void | Promise<void>
Returns
void
renderText()
renderText(
outputType,textType,text,options?):string
Defined in: src/modules/wiki.d.ts:354
Parse text in a specified format and render it into another format
Parameters
outputType
content type for the output
textType
string
content type of the input text
text
string
input text
options?
Partial<IMakeWidgetOptions> & IParseOptions
see below, Options includes:
- variables: hashmap of variables to set
- parentWidget: optional parent widget for the root node
Returns
string
renderTiddler()
renderTiddler(
outputType,title,options?):string
Defined in: src/modules/wiki.d.ts:340
Parse text from a tiddler and render it into another format outputType: content type for the output title: title of the tiddler to be rendered options: see below Options include: variables: hashmap of variables to set parentWidget: optional parent widget for the root node
Parameters
outputType
title
string
options?
Returns
string
search()
search(
text,options?):string[]
Defined in: src/modules/wiki.d.ts:80
Return an array of tiddler titles that match a search string
Parameters
text
string
The text string to search for
options?
Search options
anchored?
boolean
If true, forces all but regexp searches to be anchored to the start of text
caseSensitive?
boolean
If true forces a case sensitive search
exclude?
string[]
An array of tiddler titles to exclude from the search
excludeField?
boolean
If true, the field options are inverted to specify the fields that are not to be searched
field?
string | string[]
If specified, restricts the search to the specified field, or an array of field names
invert?
boolean
If true returns tiddlers that do not contain the specified string
literal?
boolean
Searches for literal string
regexp?
boolean
Treats the search term as a regular expression
some?
boolean
Treats search string as a list of tokens, and matches if at least ONE token is found
source?
(callback) => void
An iterator function for the source tiddlers
whitespace?
boolean
Same as literal except runs of whitespace are treated as a single space
words?
boolean
Treats search string as a list of tokens, and matches if all tokens are found
Returns
string[]
setText()
setText(
title,field?,index?,value?,options?):void
Defined in: src/modules/wiki.d.ts:293
Set tiddler text of any field.
Parameters
title
string
title of tiddler
field?
string
field name to set
index?
string
data index(key) to set, if you are setting a JSON data tiddler. Be undefined if you are just setting a normal tiddler's field, this will be most of the case.
value?
string
text content to set
options?
options, see tiddlywiki dev doc for details
suppressTimestamp?
boolean
Returns
void
setTextReference()
setTextReference(
textReference,value,currentTiddlerTitle?):void
Defined in: src/modules/wiki.d.ts:138
Set the value of a text reference
Parameters
textReference
string
value
string
The value to set
currentTiddlerTitle?
string
Returns
void
setTiddlerData()
setTiddlerData(
title,data?,fields?,options?):void
Defined in: src/modules/wiki.d.ts:220
Set JSON tiddler, Object in data field will be JSON.stringify and put into the text.
This will make tiddler to be JSON data tiddler "type":"application/json", so if you just want to modify existed tiddler's data, use addTiddler instead.
Parameters
title
string
data?
object
fields?
options?
suppressTimestamp?
boolean
Returns
void
slugify()
slugify(
title,options?):string
Defined in: src/modules/wiki.d.ts:528
Convert a title to a URL-friendly slug
Parameters
title
string
Title to slugify
options?
Options (currently unused)
separator?
string
Returns
string
sortByList()
sortByList(
array,listTitle):string[]
Defined in: src/modules/wiki.d.ts:486
Sorts an array of tiddler titles according to an ordered list
Parameters
array
string[]
Array of tiddler titles to sort
listTitle
string
Title of tiddler containing the ordered list
Returns
string[]
sortTiddlers()
sortTiddlers(
titles,sortField,isDescending?,isCaseSensitive?,isNumeric?,isAlphaNumeric?):void
Defined in: src/modules/wiki.d.ts:74
Sort an array of tiddler titles by a specified field
Parameters
titles
string[]
Array of titles (sorted in place)
sortField
string
Name of field to sort by
isDescending?
boolean
True if the sort should be descending
isCaseSensitive?
boolean
True if the sort should consider upper and lower case letters to be different
isNumeric?
boolean
True if the sort should be numeric
isAlphaNumeric?
boolean
True if the sort should be alphanumeric
Returns
void
tiddlerExists()
tiddlerExists(
title):boolean
Defined in: src/modules/wiki.d.ts:403
Test for the existence of a tiddler (excludes shadow tiddlers)
Parameters
title
string
Returns
boolean