Skip to content

Commit

Permalink
docs: added horizontal lines between api functions [skip ci]
Browse files Browse the repository at this point in the history
  • Loading branch information
Swiftwork authored Mar 11, 2021
1 parent 337ca61 commit 037c0dc
Showing 1 changed file with 10 additions and 0 deletions.
10 changes: 10 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,8 @@ register(eventType: string, schema: object): boolean;

**Returns** - returns true if event channel already existed of false if a new one was created.

---

### Unregister

Unregister the schema for the specified event type if channel exists.
Expand All @@ -268,6 +270,8 @@ unregister(eventType: string): boolean;

**Returns** - returns true if event channel existed and an existing schema was removed.

---

### Subscribe

Subscribe to an event channel triggering callback on received event matching type,
Expand All @@ -291,6 +295,8 @@ subscribe<T>(eventType: string, replay: boolean, callback: Callback<T>): { unsub

**Returns** - object containing an unsubscribe method

---

### Publish

Publish to event channel with an optional payload triggering all subscription callbacks.
Expand All @@ -308,6 +314,8 @@ publish<T>(eventType: string, detail?: T): void;

**Returns** - void

---

### Get Latest

Get the latest published payload on the specified event channel.
Expand All @@ -324,6 +332,8 @@ getLatest<T>(eventType: string): T | undefined;

**Returns** - the latest payload or `undefined`

---

### Get Schema

Get the schema registered on the specified event channel.
Expand Down

0 comments on commit 037c0dc

Please sign in to comment.