From 037c0dcc3c40deaa1107f52c3dadc91ea244d842 Mon Sep 17 00:00:00 2001 From: Erik Hughes Date: Thu, 11 Mar 2021 10:07:16 +0100 Subject: [PATCH] docs: added horizontal lines between api functions [skip ci] --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 6433a72..a6d58ad 100644 --- a/README.md +++ b/README.md @@ -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. @@ -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, @@ -291,6 +295,8 @@ subscribe(eventType: string, replay: boolean, callback: Callback): { unsub **Returns** - object containing an unsubscribe method +--- + ### Publish Publish to event channel with an optional payload triggering all subscription callbacks. @@ -308,6 +314,8 @@ publish(eventType: string, detail?: T): void; **Returns** - void +--- + ### Get Latest Get the latest published payload on the specified event channel. @@ -324,6 +332,8 @@ getLatest(eventType: string): T | undefined; **Returns** - the latest payload or `undefined` +--- + ### Get Schema Get the schema registered on the specified event channel.