From fcb45a42ea414516e82308ba15be0ac0ac84337e Mon Sep 17 00:00:00 2001 From: ivandotv Date: Thu, 14 Apr 2022 09:03:04 +0000 Subject: [PATCH] Generate docs --- docs/api/README.md | 2 +- docs/api/classes/default.md | 26 +++++++++++++------------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/docs/api/README.md b/docs/api/README.md index f7d6877..370b158 100644 --- a/docs/api/README.md +++ b/docs/api/README.md @@ -33,4 +33,4 @@ oktopod #### Defined in -[src/oktopod.ts:11](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L11) +[src/oktopod.ts:11](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L11) diff --git a/docs/api/classes/default.md b/docs/api/classes/default.md index 1f175df..db4972c 100644 --- a/docs/api/classes/default.md +++ b/docs/api/classes/default.md @@ -31,7 +31,7 @@ #### Defined in -[src/oktopod.ts:39](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L39) +[src/oktopod.ts:39](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L39) ## Properties @@ -46,12 +46,12 @@ Xstate action helpers bound to the current instance | Name | Type | | :------ | :------ | | `emit` | (`eventName`: `string` \| (`ctx`: `any`, `evt`: `any`) => `string`, `data`: `any`) => `any` | -| `forwardTo` | (`serviceId`: `string` \| `string`[] \| (`ctx`: `any`, `evt`: `any`) => `string` \| `string`[]) => (`ctx`: `any`, `evt`: `any`) => `void` | -| `sendTo` | (`serviceId`: `string` \| `string`[] \| (`ctx`: `any`, `evt`: `any`) => `string` \| `string`[], `event`: `ResolveEventType`<`TService`\> \| (`ctx`: `any`, `evt`: `any`) => `ResolveEventType`<`TService`\>) => (`ctx`: `any`, `evt`: `any`) => `void` | +| `forwardTo` | (`serviceId`: `string` \| `string`[] \| (`ctx`: `any`, `evt`: `any`) => `string` \| `string`[], `strict?`: `boolean`) => (`ctx`: `any`, `evt`: `any`) => `void` | +| `sendTo` | (`serviceId`: `string` \| `string`[] \| (`ctx`: `any`, `evt`: `any`) => `string` \| `string`[], `event`: `ResolveEventType`<`TService`\> \| (`ctx`: `any`, `evt`: `any`) => `ResolveEventType`<`TService`\>, `strict?`: `boolean`) => (`ctx`: `any`, `evt`: `any`) => `void` | #### Defined in -[src/oktopod.ts:37](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L37) +[src/oktopod.ts:37](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L37) ## Methods @@ -73,7 +73,7 @@ Clear all listeners for a specific event #### Defined in -[src/oktopod.ts:224](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L224) +[src/oktopod.ts:224](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L224) ___ @@ -96,7 +96,7 @@ Emit event to all listeners #### Defined in -[src/oktopod.ts:239](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L239) +[src/oktopod.ts:239](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L239) ___ @@ -126,7 +126,7 @@ Xstate service #### Defined in -[src/oktopod.ts:288](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L288) +[src/oktopod.ts:288](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L288) ___ @@ -151,7 +151,7 @@ true if unregistered successfully #### Defined in -[src/oktopod.ts:173](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L173) +[src/oktopod.ts:173](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L173) ___ @@ -186,7 +186,7 @@ function to unsubscribe #### Defined in -[src/oktopod.ts:49](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L49) +[src/oktopod.ts:49](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L49) ▸ **on**<`TService`\>(`event`, `listener`, `send`): (`unregister?`: `boolean`) => `void` @@ -232,7 +232,7 @@ also unregistered from the event bus #### Defined in -[src/oktopod.ts:59](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L59) +[src/oktopod.ts:59](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L59) ___ @@ -268,7 +268,7 @@ function to unregister the service #### Defined in -[src/oktopod.ts:249](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L249) +[src/oktopod.ts:249](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L249) ___ @@ -298,7 +298,7 @@ Send a particular event to a particular service #### Defined in -[src/oktopod.ts:303](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L303) +[src/oktopod.ts:303](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L303) ___ @@ -320,4 +320,4 @@ Unregister service from the event bus #### Defined in -[src/oktopod.ts:268](https://github.com/ivandotv/oktopod/blob/28ee36d/src/oktopod.ts#L268) +[src/oktopod.ts:268](https://github.com/ivandotv/oktopod/blob/50bc108/src/oktopod.ts#L268)