Add api docs

docs/.vitepress/config.ts

@@ -1,4 +1,5 @@
 import { defineConfig } from 'vitepress'
+import typedocSidebar from '../api/typedoc-sidebar.json';
 
 export default defineConfig({
   title: "Kitbag Events | Simple lightweight event bus written in Typescript.",
@@ -8,15 +9,22 @@ export default defineConfig({
     logo: '/kitbag-logo-circle.svg',
     siteTitle: 'Kitbag Events',
 
+    editLink: {
+      pattern: 'https://github.com/kitbagjs/events/edit/main/docs/:path',
+      text: 'Suggest changes to this page',
+    },
+
+    nav: [
+      { text: 'Guide', link: '/getting-started' },
+      { text: 'API', link: '/api/index' }
+    ],
+
+    search: {
+      provider: 'local'
+    },
+
     sidebar: {
-      '/api/': [
-        {
-          text: 'packages',
-          items: [
-            { text: '@kitbag/events', link: '/api/modules/kitbag' },
-          ],
-        },
-      ],
+      '/api/': typedocSidebar,
       '/': [
         {
           text: 'Guide',

docs/api/errors/EmitterTimeoutError.md

@@ -0,0 +1,69 @@
+# Errors: EmitterTimeoutError
+
+An error thrown when a timeout occurs while waiting for an event to be emitted.
+
+## Extends
+
+- `Error`
+
+## Constructors
+
+### new EmitterTimeoutError()
+
+```ts
+new EmitterTimeoutError(event, timeout): EmitterTimeoutError
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `string` |
+| `timeout` | `number` |
+
+#### Returns
+
+[`EmitterTimeoutError`](EmitterTimeoutError.md)
+
+#### Overrides
+
+```ts
+Error.constructor
+```
+
+## Methods
+
+### captureStackTrace()
+
+```ts
+static captureStackTrace(targetObject, constructorOpt?): void
+```
+
+Create .stack property on a target object
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `targetObject` | `object` |
+| `constructorOpt`? | `Function` |
+
+#### Returns
+
+`void`
+
+#### Inherited from
+
+```ts
+Error.captureStackTrace
+```
+
+## Properties
+
+| Property | Modifier | Type | Description | Inherited from |
+| ------ | ------ | ------ | ------ | ------ |
+| <a id="message"></a> `message` | `public` | `string` | - | `Error.message` |
+| <a id="name"></a> `name` | `public` | `string` | - | `Error.name` |
+| <a id="stack"></a> `stack?` | `public` | `string` | - | `Error.stack` |
+| <a id="preparestacktrace"></a> `prepareStackTrace?` | `static` | (`err`: `Error`, `stackTraces`: `CallSite`[]) => `any` | Optional override for formatting stack traces **See** https://v8.dev/docs/stack-trace-api#customizing-stack-traces | `Error.prepareStackTrace` |
+| <a id="stacktracelimit"></a> `stackTraceLimit` | `static` | `number` | - | `Error.stackTraceLimit` |

docs/api/functions/createEmitter.md

@@ -0,0 +1,254 @@
+# Functions: createEmitter()
+
+```ts
+function createEmitter<TEvents>(options?): object
+```
+
+## Type Parameters
+
+| Type Parameter |
+| ------ |
+| `TEvents` *extends* [`EmitterEvents`](../types/EmitterEvents.md) |
+
+## Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | [`EmitterOptions`](../types/EmitterOptions.md) |
+
+## Returns
+
+`object`
+
+### clear()
+
+```ts
+clear: () => void;
+```
+
+#### Returns
+
+`void`
+
+### emit()
+
+```ts
+emit: <E>(event) => void<E>(event, payload) => void;
+```
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `undefined` *extends* [`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\> ? `E` : `never` |
+
+#### Returns
+
+`void`
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+| `payload` | [`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\> |
+
+#### Returns
+
+`void`
+
+### next()
+
+```ts
+next: (options?) => Promise<GlobalEventHandlerResponse<TEvents>><E>(event, options?) => Promise<EventPayload<TEvents, E>>;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options`? | [`EmitterNextOptions`](../types/EmitterNextOptions.md) |
+
+#### Returns
+
+`Promise`\<[`GlobalEventHandlerResponse`](../types/GlobalEventHandlerResponse.md)\<`TEvents`\>\>
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+| `options`? | [`EmitterNextOptions`](../types/EmitterNextOptions.md) |
+
+#### Returns
+
+`Promise`\<[`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\>\>
+
+### off()
+
+```ts
+off: (globalEventHandler) => void<E>(event) => void<E>(event, handler) => void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `globalEventHandler` | [`GlobalEventHandler`](../types/GlobalEventHandler.md)\<`TEvents`\> |
+
+#### Returns
+
+`void`
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+
+#### Returns
+
+`void`
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+| `handler` | [`EventHandler`](../types/EventHandler.md)\<[`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\>\> |
+
+#### Returns
+
+`void`
+
+### on()
+
+```ts
+on: (globalEventHandler, options?) => () => void<E>(event, handler, options?) => () => void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `globalEventHandler` | [`GlobalEventHandler`](../types/GlobalEventHandler.md)\<`TEvents`\> |
+| `options`? | [`EmitterOnOptions`](../types/EmitterOnOptions.md) |
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+| `handler` | [`EventHandler`](../types/EventHandler.md)\<[`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\>\> |
+| `options`? | [`EmitterOnOptions`](../types/EmitterOnOptions.md) |
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+### once()
+
+```ts
+once: (globalEventHandler, options?) => () => void<E>(event, handler, options?) => () => void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `globalEventHandler` | [`GlobalEventHandler`](../types/GlobalEventHandler.md)\<`TEvents`\> |
+| `options`? | [`EmitterOnceOptions`](../types/EmitterOnceOptions.md) |
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+#### Type Parameters
+
+| Type Parameter |
+| ------ |
+| `E` *extends* `string` \| `number` \| `symbol` |
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `event` | `E` |
+| `handler` | [`EventHandler`](../types/EventHandler.md)\<[`EventPayload`](../types/EventPayload.md)\<`TEvents`, `E`\>\> |
+| `options`? | [`EmitterOnceOptions`](../types/EmitterOnceOptions.md) |
+
+#### Returns
+
+`Function`
+
+##### Returns
+
+`void`
+
+### setOptions()
+
+```ts
+setOptions: (options) => void;
+```
+
+#### Parameters
+
+| Parameter | Type |
+| ------ | ------ |
+| `options` | [`EmitterOptions`](../types/EmitterOptions.md) |
+
+#### Returns
+
+`void`

docs/api/index.md

@@ -0,0 +1,21 @@
+# @kitbag/events
+
+## Functions
+
+- [createEmitter](functions/createEmitter.md)
+
+## Types
+
+- [EmitterEvents](types/EmitterEvents.md)
+- [EmitterNextOptions](types/EmitterNextOptions.md)
+- [EmitterOnceOptions](types/EmitterOnceOptions.md)
+- [EmitterOnOptions](types/EmitterOnOptions.md)
+- [EmitterOptions](types/EmitterOptions.md)
+- [EventHandler](types/EventHandler.md)
+- [EventPayload](types/EventPayload.md)
+- [GlobalEventHandler](types/GlobalEventHandler.md)
+- [GlobalEventHandlerResponse](types/GlobalEventHandlerResponse.md)
+
+## Errors
+
+- [EmitterTimeoutError](errors/EmitterTimeoutError.md)