tw5-typed 0.5.14 → 0.6.1

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "tw5-typed",
-  "version": "0.5.14",
+  "version": "0.6.1",
   "scripts": {
     "check": "tsc --noEmit && eslint src/**/*.ts",
     "docs": "docs-ts",
@@ -23,6 +23,13 @@
     "url": "git+https://github.com/tiddly-gittly/tw5-typed.git"
   },
   "types": "src/index.d.ts",
+  "exports": {
+    ".": {
+      "import": "./src/index.d.ts",
+      "require": "./src/index.d.ts",
+      "types": "./src/index.d.ts"
+    }
+  },
   "files": [
     "src/"
   ],

package/src/hooks.d.ts

@@ -1,4 +1,12 @@
 declare module 'tiddlywiki' {
+  interface ImportFileInfo {
+    // eslint-disable-next-line @typescript-eslint/ban-types
+    callback: Function;
+    file: { lastModified?: number; lastModifiedDate?: Date; name: string; path?: string; size: number; type: string; webkitRelativePath?: string };
+    isBinary: boolean;
+    type: string;
+  }
+
   interface IHooks {
     /** Add hooks to the hashmap */
     addHook(
@@ -66,19 +74,13 @@ declare module 'tiddlywiki' {
     addHook(hookName: 'th-page-refreshed', callback: () => void);
     addHook(
       hookName: 'th-importing-file',
-      callback: (props: {
-        // eslint-disable-next-line @typescript-eslint/ban-types
-        callback: Function;
-        file: { name: string; path?: string };
-        isBinary: boolean;
-        type: string;
-      }) => boolean | undefined,
+      callback: (props: ImportFileInfo) => boolean | undefined,
     );
     addHook(hookName: string, callback: (...arguments_: unknown[]) => unknown);
     /**
      * Invoke the hook by key
      */
-    invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent | undefined;
+    invokeHook(hookName: string, event: IWidgetEvent): undefined | IWidgetEvent;
     // eslint-disable-next-line @typescript-eslint/ban-types
     names: Record<string, Function[]>;
   }

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

@@ -1,5 +1,18 @@
 declare module 'tiddlywiki' {
   /**
+   * # Usage
+   * 
+   * ```ts
+   * const yourFilter: IFilterOperator = (source,operator) => {
+   * 	var results = [];
+   * 	source(function(tiddler,title) {
+   * 	  if (!tiddler.fields['xxx']) return;
+   * 	  results.push(title);
+   * 	});
+   * 	return results;
+   * }
+   * ```
+   * 
    * # Overview
 
 Filter operators are modules (tiddlers of type `application/javascript`) with their `module-type` field set to `filteroperator`, exporting one or more functions implementing a filter.

package/src/modules/utils/parseutils.d.ts

@@ -41,7 +41,7 @@ declare module '$:/core/modules/utils/parseutils.js' {
   export function parseStringLiteral(source: string, pos: number): { end: number; start: number; type: 'string'; value: string } | null;
 
   /**
-   * Returns an array of {name:} with an optional "default" property. Options include `requireParenthesis`.
+   * Returns an array of `{name:}` with an optional "default" property. Options include `requireParenthesis`.
    */
   export function parseParameterDefinition(parameterString: string, options?: { requireParenthesis?: boolean }): Array<{ default?: string; name: string }>;