tw5-typed 0.0.1 → 0.0.2

package/README.md

@@ -1,2 +1,27 @@
 # TW5-Typed
+
 TypeScript type definitions for TiddlyWiki5.
+
+## Usage
+
+First, install it as dev-dependency:
+
+```sh
+npm i -D tw5-typed
+```
+
+Add `tw5-typed` to your `tsconfig.json`'s `compilerOptions`
+
+```json
+{
+  "compilerOptions": {
+    "types": ["node", "tw5-typed"] /* Type declaration files to be included in compilation. */,
+  }
+}
+```
+
+Then you will have global types like `$tw` automatically. You can import the rest of the types using `import type` statement:
+
+```typescript
+
+```

package/package.json

@@ -2,15 +2,16 @@
   "description": "Types for tiddlywiki",
   "license": "MIT",
   "name": "tw5-typed",
-  "version": "0.0.1",
+  "version": "0.0.2",
   "url": "https://github.com/tiddly-gittly/tw5-typed",
-  "types": "src/index.d.ts",
+  "types": "index.d.ts",
+  "files": [
+    "src/"
+  ],
   "author": "",
-  "scripts": {
-  },
+  "scripts": {},
   "devDependencies": {
     "typescript": "^4.5.5"
   },
-  "dependencies": {
-  }
+  "dependencies": {}
 }

package/src/tw.d.ts

@@ -38,6 +38,8 @@ export interface I$TW {
   hooks: { addHook: (hookName: string, callback: (...arguments_: any[]) => unknown) => void };
   wiki: {
     getTiddler: (title: string) => ITiddler | undefined;
+    getTiddlers: () => ITiddler[];
   };
+  utils: Record<string, any>;
 }
 export function TiddlyWiki(): I$TW;