Updated docs

.github/workflows/build.yaml

@@ -48,3 +48,13 @@ jobs:
           uses: ztimson/actions/tag@develop
           with:
             tag: ${{env.VERSION}}
+
+
+  docs:
+    name: Publish Documentation
+    needs: build
+    uses: ztimson/actions/.github/workflows/docker.yaml@develop
+    with:
+        name: ztimson/utils
+        repository: ${{github.server_url}}/${{github.repository}}.git
+        pass: ${{secrets.DEPLOY_TOKEN}}

Dockerfile

@@ -0,0 +1,13 @@
+# Build application
+FROM node:alpine as build
+
+RUN mkdir /app
+WORKDIR /app
+COPY . .
+RUN if [ ! -d "node_modules" ]; then npm i; fi && \
+    if [ ! -d "dist" ]; then npm run docs; fi
+
+# Use Nginx to serve
+FROM nginx:1.23-alpine
+
+COPY --from=build /app/docs /usr/share/nginx/html

README.md

@@ -20,7 +20,7 @@ Javascript/Typescript Utilities
 
   ---
   <div>
-    <a href="https://git.zakscode.com/ztimson/utils/wiki" target="_blank">Documentation</a>
+    <a href="https://utils.docs.zakscode.com" target="_blank">Documentation</a>
     • <a href="https://git.zakscode.com/ztimson/utils/releases" target="_blank">Release Notes</a>
     • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fbug.md" target="_blank">Report a Bug</a>
     • <a href="https://git.zakscode.com/ztimson/utils/issues/new?template=.github%2fissue_template%2fenhancement.md" target="_blank">Request a Feature</a>
@@ -36,7 +36,7 @@ Javascript/Typescript Utilities
 	- [Setup](#setup)
 		- [Production](#production)
 		- [Development](#development)
-	- [Documentation](https://git.zakscode.com/ztimson/utils/wiki)
+	- [Documentation](https://utils.docs.zakscode.com/)
 	- [License](#license)
 
 ## About
@@ -82,7 +82,7 @@ A collection of utilities to make life a little easier
 
 ## Documentation
 
-[Available Here](https://git.zakscode.com/ztimson/utils/wiki)
+[Available Here](https://utils.docs.zakscode.com/)
 
 ## License
 

package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@ztimson/utils",
-	"version": "0.16.10",
+	"version": "0.17.1",
 	"description": "Utility library",
 	"author": "Zak Timson",
 	"license": "MIT",
@@ -21,7 +21,7 @@
 	},
 	"scripts": {
 		"build": "npx tsc && npx vite build",
-		"docs": "typedoc --plugin typedoc-plugin-markdown --cleanOutputDir false --outputFileStrategy modules --hidePageHeader --out ./docs --entryPoints src/**/*.ts --readme none --entryFileName Home",
+		"docs": "typedoc --cleanOutputDir false --out ./docs --entryPoints src/**/*.ts --readme none",
 		"test": "npx jest",
 		"test:coverage": "npx jest --coverage",
 		"watch": "npx vite build --watch"
@@ -32,12 +32,14 @@
 		"jest-junit": "^16.0.0",
 		"ts-jest": "^29.1.2",
 		"typedoc": "^0.26.7",
-		"typedoc-plugin-markdown": "^4.2.7",
 		"typescript": "^5.3.3",
 		"vite": "^5.0.12",
 		"vite-plugin-dts": "^3.7.2"
 	},
 	"files": [
 		"dist"
-	]
+	],
+	"dependencies": {
+		"var-persist": "^1.0.1"
+	}
 }

src/emitter.ts

@@ -1,6 +1,10 @@
 export type Listener = (...args: any[]) => any;
 export type TypedEvents = {[k in string | symbol]: Listener} & {'*': (event: string, ...args: any[]) => any};
 
+export type NamespaceEvents<Namespace extends string, Events extends TypedEvents> = {
+	[K in keyof Events as `${Namespace}:${Extract<K, string>}`]: Events[K];
+};
+
 export class TypedEmitter<T extends TypedEvents = TypedEvents> {
 	private static listeners: {[key: string]: Listener[]} = {};
 

src/index.ts

@@ -15,3 +15,4 @@ export * from './promise-progress';
 export * from './string';
 export * from './time';
 export * from './types';
+export * from 'var-persist';