Thor Event Emitter
Event emitter to manage your state.
An event emitter that allows you to manage your global state. Instead of using global giant object to store your shared sate, you can simply emit the events you need with the necessary payload and keep your state managed locally.
npm install thor-event
Somewhere in your code:
import ThorEvent from "thor-event";
const appEvent = new ThorEvent();
appEvent.emit({
id: "evt-1",
type: "auth",
issuer: "api.auth.com",
type: "auth", // notify all listeners of this type
payload: {
name: "name",
address: "address-1",
},
});
And inside you React JSX component
{ appEvent.off("auth", handleUserAuth); }; }, []); return (
);">
userInfo
const handleUserAuth = ({payload, ...rest}: UserInfo) => { // update my state locally setUserInfo({...payload)}; // do something else with the rest }; React.useEffect(() => { appEvent.on("auth", handleUserAuth); return () => { appEvent.off("auth", handleUserAuth); }; }, []); return ( <div> <p>userInfo</p> </div> );
API
Initialize the event emitter (optional):
init(evt: EventInterface<EventTypes, PayLoadInterface, IssuerTypes>)
The evt object contains:
id?: string,type?: EventTypes | string,issuer?: IssuerTypes | string,payload?: PayLoadInterface | any,
Update the payload of an event:
setPayload(evt: EventInterface<EventTypes, PayLoadInterface, IssuerTypes>)
Update the id of an event:
updateID({ id, newID });
id: string,newID: string,
To get all events from the same type:
getEventsByType(type?: EventTypes | string) : EventInterface[]
Bind an event listener to an event type:
on(type: EventTypes | string, listeners: (evt: EventInterface<EventTypes, PayLoadInterface, IssuerTypes>) => void)
Emit an event:
emit(evt: EventInterface<EventTypes, PayLoadInterface, IssuerTypes>)
To clear event and its binding listeners:
clear(id:string)
Unbind an event listener:
off(type: EventTypes | string, listeners: (evt: EventInterface<EventTypes, PayLoadInterface, IssuerTypes>) => void)
Test
npm test
License
This project is licensed under the MIT
3 Jul 2, 2022
25 Sep 11, 2022
55 Dec 30, 2022
3 May 23, 2022
11 Jan 4, 2023
3 Mar 23, 2022
13 Apr 22, 2022
12 Oct 18, 2022
10 Dec 15, 2022
112 Dec 26, 2022
3 May 3, 2022
13 Aug 22, 2022
4 Dec 20, 2022
4 Dec 14, 2022
9 Apr 4, 2022
21 Dec 11, 2022
6 May 19, 2022
65 Nov 2, 2022
9 Nov 22, 2022