tw5-typed 0.3.7 → 0.3.8

package/package.json

@@ -2,7 +2,7 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.3.7",
+  "version": "0.3.8",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
   "homepage": "https://github.com/tiddly-gittly/tw5-typed",
   "bugs": {

package/src/modules/widgets/index.d.ts

@@ -56,6 +56,13 @@ declare module 'tiddlywiki' {
     widget: Widget;
   }
 
+  export interface IGetWidgetVariableOptions {
+    params?: IWidgetVariableParam[];
+    defaultValue?: string;
+    allowSelfAssigned?: boolean;
+    source?: (iter: SourceIterator) => void;
+  }
+
   /**
    * @link https://tiddlywiki.com/dev/#Widgets
    *
@@ -171,32 +178,25 @@ declare module 'tiddlywiki' {
     ): void;
 
     /**
-     * Get variable in the context of the widget.
-     * Simplified version of getVariableInfo() that just returns the text.
+     * Get the prevailing value of a context variable
      * @param name variable name, for example, `currentTiddler` in the widget context
      * @param options options for getVariableInfo()
      *
      * Options include
      * * params: array of {name:, value:} for each parameter
      * * defaultValue: default value if the variable is not defined
+     * * source: optional source iterator for evaluating function invocations
+     * * allowSelfAssigned: if true, includes the current widget in the context chain instead of just the parent
      *
      * Returns an object with the following fields:
      * * params: array of {name:,value:} of parameters passed to wikitext variables
      * * text: text of variable, with parameters properly substituted
-     *
-     * @param {string} name
-     * @param {{ params?: IWidgetVariableParam[]; defaultValue: string }} [options]
-     * @return {*}  {{
-     *       text: string;
-     *       params?: IWidgetVariableParam[];
-     *       srcVariable?: IWidgetVariable;
-     *       isCacheable?: boolean;
-     *     }}
-     * @memberof Widget
+     * * resultList: result of variable evaluation as an array
+     * * srcVariable: reference to the object defining the variable
      */
     getVariableInfo(
       name: string,
-      options?: { params?: IWidgetVariableParam[]; defaultValue: string },
+      options?: IGetWidgetVariableOptions,
     ): {
       text: string;
       params?: IWidgetVariableParam[];
@@ -206,16 +206,8 @@ declare module 'tiddlywiki' {
 
     /**
      * Simplified version of getVariableInfo() that just returns the text
-     *
-     * @param {string} name
-     * @param {{ params?: IWidgetVariableParam[]; defaultValue: string }} [options]
-     * @return {*}  {string}
-     * @memberof Widget
      */
-    getVariable(
-      name: string,
-      options?: { params?: IWidgetVariableParam[]; defaultValue: string },
-    ): string;
+    getVariable(name: string, options?: IGetWidgetVariableOptions): string;
 
     resolveVariableParameters(
       formalParams?: IWidgetVariableParam[],

package/src/wiki/index.d.ts

@@ -34,6 +34,12 @@ declare module 'tiddlywiki' {
      * Get full list of tiddler titles in the wiki
      */
     getTiddlers(): string[];
+    /**
+     * Get JSON string of tiddlers. Note that this will make lists like tags/list to be string, instead of array.
+     * @param filter Filter string
+     * @param spaces Last arg of `JSON.stringify`, default is `'  '`
+     */
+    getTiddlersAsJson(filter: string, spaces?: string): string;
     deleteTiddler(title: string): void;
     each(callback: (tiddler: Tiddler, title: string) => void): void;
     /**