tw5-typed 0.4.6 → 0.4.8

package/package.json

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

package/src/tiddler/index.d.ts

@@ -27,8 +27,8 @@ declare module 'tiddlywiki' {
      */
     constructor(...tiddlers: Array<Record<string, unknown> | Tiddler>);
 
-    hasTag(field: string): boolean;
-    hasField(): boolean;
+    hasTag(tag: string): boolean;
+    hasField(field: string): boolean;
     isPlugin(): boolean;
     isDraft(): boolean;
     /**

package/src/wiki/index.d.ts

@@ -20,6 +20,10 @@ declare module 'tiddlywiki' {
     Partial<ITiddlerFields>,
     'created' | 'modified'
   > & { created?: string; modified?: string };
+  export type ITiddlerJSONResult = Omit<
+    Partial<ITiddlerFieldsParam>,
+    'list' | 'tags'
+  > & { list?: string; tags?: string };
   export class Wiki {
     /**
      * 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.
@@ -35,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): 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;
     /**