All files / src event.ts

47.45% Statements 28/59
100% Branches 0/0
0% Functions 0/4
47.45% Lines 28/59

Press n or j to go to the next uncovered block, b, p or k for the previous block.

1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 591x 1x 1x 1x 1x 1x 1x 1x 1x               1x 1x 1x                   1x 1x 1x 1x 1x 1x 1x                 1x 1x 1x 1x               1x 1x 1x 1x 1x
 
import { isset } from 'topkat-utils'
import { newSystemCtx } from './ctx'
 
export const event = {
    /**
     * @param priority the higher the prior
     */
    on<EventName extends keyof GDeventNames>(
        eventName: EventName,
        callback: (...params: GDeventNames[EventName]) => any,
        priority = 50
    ) {
        event.registeredEvents[eventName] ??= []
        event.registeredEvents[eventName].push([priority, callback])
        event.registeredEvents[eventName].sort(([priorityA], [priorityB]) => priorityA - priorityB)
    },
    /** unregister a callback from an event */
    off<EventName extends keyof GDeventNames>(
        eventName: EventName,
        callback: (...params: GDeventNames[EventName]) => any,
    ) {
        if (!isset(event.registeredEvents[eventName])) return
        const eventIndex = event.registeredEvents[eventName].findIndex(([, callback2]) => callback === callback2)
        if (eventIndex !== -1) {
            event.registeredEvents[eventName].splice(eventIndex, 1)
            return true
        } else return false
    },
    /** asynchronous error catchable event
     * will run all callbacks according to their priority
     * @param {array} paramsValidationArray
     * @returns {Object} metadata (will be passed as final argument of each event function to be modified by the different modules)
    */
    async emit<EventName extends keyof GDeventNames>(
        eventName: EventName,
        ...params: GDeventNames[EventName]
    ) {
        // TODO try catch in all events and message like plz use try catch in your events handlers
        const metadata = {}
        event.registeredEvents[eventName] ??= []
        for (const [, callback] of event.registeredEvents[eventName]) await callback(...params, metadata)
        return metadata
    },
    /** SYNCHRONOUS
    */
    emitSync<EventName extends keyof GDeventNames>(
        eventName: EventName,
        ...params: GDeventNames[EventName]
    ) {
        const metadata = {}
        event.registeredEvents[eventName] ??= []
        for (const [, callback] of event.registeredEvents[eventName]) callback(newSystemCtx(), ...params, metadata)
        return metadata
    },
    registeredEvents: {} as { [EventName: string]: Array<[priority: number, callback: Function]> },
}
 
export default event // @deprecated default