tw5-typed 0.4.7 → 0.4.9

package/package.json

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

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

@@ -114,7 +114,7 @@ As with [JavaScript Macros](#JavaScript%20Macros), filter operators should not m
 
     Construct the iterator using $tw.wiki.makeTiddlerIterator
    */
-  export type SourceIterator = (tiddler: Tiddler, title: string) => void;
+  export type SourceIterator = (tiddler: Tiddler | undefined, title: string) => void;
   export interface ISearchOptions {
     /** If true, forces all but regexp searches to be anchored to the start of text */
     anchored?: boolean;
@@ -141,6 +141,8 @@ As with [JavaScript Macros](#JavaScript%20Macros), filter operators should not m
   export interface IFilterOperatorParameterOperator {
     /** the operand for the filter step (as a string; if the filter specified it in angle brackets or braces, the text reference or letiable name will have already been resolved); */
     operand: string;
+    /** Filter can have one or more operands, like `charcode[13],[10]`. */
+    operands: string[];
     /** the name of the filter operator specified in the WikiText; */
     operator: string;
     /** (optional) a string containing a single exclamation mark if the filter operator is to be negated; */

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

@@ -379,10 +379,11 @@ declare module 'tiddlywiki' {
 
     /**
      * Add a list of event listeners from an array [{type:,handler:},...]
+     * See also `addEventListener`.
      */
     addEventListeners(
       listeners: {
-        handler: (event: IWidgetEvent) => void | Promise<void>;
+        handler: (event: IWidgetEvent) => void | Promise<void> | boolean;
         type: string;
       }[],
     ): void;
@@ -395,7 +396,7 @@ declare module 'tiddlywiki' {
      */
     addEventListener(
       type: string,
-      handler: (event: IWidgetEvent) => void | Promise<void>,
+      handler: (event: IWidgetEvent) => void | Promise<void> | boolean,
     ): void;
 
     /**

package/src/wiki/index.d.ts

@@ -39,11 +39,18 @@ declare module 'tiddlywiki' {
      */
     getTiddlers(): string[];
     /**
-     * Get JSON string of tiddlers. Note that this will make lists like tags/list to be string, instead of array.
+     * 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.
      * @param filter Filter string
      * @param spaces Last arg of `JSON.stringify`, default is `'  '`
+     * @returns a stringified JSON with type ITiddlerJSONResult. You will need to use `JSON.parse` on it.
      */
-    getTiddlersAsJson(filter: string, spaces?: string): ITiddlerJSONResult;
+    getTiddlersAsJson(filter: string, spaces?: string): string;
+    /**
+     * 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.
+     * @param title 
+     * @returns a stringified JSON with type ITiddlerJSONResult. You will need to use `JSON.parse` on it.
+     */
+    getTiddlerAsJson(title: string): string;
     deleteTiddler(title: string): void;
     each(callback: (tiddler: Tiddler, title: string) => void): void;
     /**
@@ -78,7 +85,7 @@ declare module 'tiddlywiki' {
     compileFilter(
       filterString: string,
     ): (
-      source?: SourceIterator | string[] | Record<string, unknown>,
+      source?: (iterator: SourceIterator) => void | string[] | Record<string, unknown>,
       widget?: Widget,
     ) => string[];
     /**