Function newEvent

Extension/src/Utility/Eventing/emitter.ts:142–195

(eventName: string, options?: EventOptions<TOutput> & WithDefault<TOutput>)

    protected newEvent<TData, TOutput>(eventName: string, options?: EventOptions & WithDefault<TOutput>): (input: TData) => Promise<TOutput>;
    protected newEvent<TText extends string, TData, TOutput>(eventName: string, options?: EventOptions<TOutput> & WithDefault<TOutput>): (text: TText, data: TData) => Promise<TOutput>;
    protected newEvent<TText extends string, TData, TOutput>(eventName: string, options?: EventOptions<TOutput> & WithDefault<TOutput>): (text: TText, data: TData) => Promise<EventStatus | TOutput> {
        eventName = smash(eventName);
        this.#knownEvents.add(eventName);
        const descriptors = options?.descriptors ? new Descriptors(this.descriptors, options.descriptors) : this.descriptors;
        // is it an immediate event?
        if (options?.now) {
            return async (input?: TText, data?: TData): Promise<TOutput | EventStatus> => {
                switch (options?.once) {
                    case false:
                        // already triggered this one time event.
                        return;

                    case true:
                        options.once = false;
                }
                // trigger the event
                const result = await ((data !== undefined) ?
                    emitNow<TOutput>(eventName, descriptors, this, input || '', data as any) : // text and data
                    emitNow<TOutput>(eventName, descriptors, this, input || '', input as any)); // text or data (or neither)

                return is.cancelled(result) ? // was the event cancelled?
                    options?.cancel?.() || Cancelled : // the event was cancelled - call the cancel function, or return Cancelled
                    is.continue(result) ? // was the event continued (handler returned nothing)?
                        is.function(options?.default) ? // the event is continued, is the default handler a function?
                            options?.default() : // the default is a function, call it.
                            options?.default || Continue : // the default is a value, call it (or just return Continue)
                        result as TOutput; // the event was not cancelled, and the handler returned a value.
            };
        }

        // otherwise queue it
        return async (input?: TText, data?: TData): Promise<TOutput | EventStatus> => {
            switch (options?.once) {
                case false:
                    // already triggered this one time event.
                    return;

                case true:
                    options.once = false;
            }
            // trigger the event
            const result = await ((data !== undefined) ?
                emit<TOutput>(eventName, descriptors, this, input || '', data as any) : // text and data
                emit<TOutput>(eventName, descriptors, this, input || '', input as any)); // text or data (or neither)

            return is.cancelled(result) ? // was the event cancelled?
                options?.cancel?.() || Cancelled : // the event was cancelled - call the cancel function, or return Cancelled
                is.continue(result) ? // was the event continued (handler returned nothing)?
                    is.function(options?.default) ? // the event is continued, is the default handler a function?
                        options?.default() : // the default is a function, call it.
                        options?.default || Continue : // the default is a value, call it (or just return Continue)
                    result as TOutput; // the event was not cancelled, and the handler returned a value.
        };
    }

    /** notification with event name, but no data in the event. */
    protected newNotification(eventName: string, options?: EventOptions): () => void;