Skip to content

Commit

Permalink
Generate docs
Browse files Browse the repository at this point in the history
  • Loading branch information
@ivandotv @github-actions
ivandotv authored and github-actions[bot] committed Apr 14, 2022
1 parent 50bc108 commit fcb45a4
Show file tree
Hide file tree
Showing 2 changed files with 14 additions and 14 deletions.
2 changes: 1 addition & 1 deletion docs/api/README.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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)
26 changes: 13 additions & 13 deletions docs/api/classes/default.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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` | <TService\>(`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` | <TService\>(`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

Expand All @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

___

Expand Down Expand Up @@ -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`

Expand Down Expand Up @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand Down Expand Up @@ -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)

___

Expand All @@ -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)

0 comments on commit fcb45a4

Please sign in to comment.