event-toolkit 
Toolkit for DOM events.
npm i event-toolkit
|
pnpm add event-toolkit
|
yarn add event-toolkit
|
API
<summary># AbortOptions </summary> src/abort.ts#L4 <summary># DispatchOptions </summary> src/dispatch.ts#L4 <summary># EventOptions </summary> src/event.ts#L7 <summary># OnOptions </summary> src/on.ts#L15 <summary># QueueOptions </summary> src/queue.ts#L11 <summary># EventHandler </summary>
<summary># this </summary> <summary># event </summary> E & {
<summary># currentTarget </summary> <summary># target </summary> }
EventHandler(this, event) =>
<summary># Hooks </summary> src/queue.ts#L6 <summary># AnyFn </summary> src/helpers.ts#L1 <summary># (args) </summary>
<summary># args </summary> (args) =>
| void | false
<summary># Dispatch </summary> src/dispatch.ts#L10 <summary># Fn </summary> <summary># (args) </summary>
<summary># args </summary> (args) =>
<summary># Off </summary> src/on.ts#L10 <summary># On </summary> src/on.ts#L11 <summary># OnEvent </summary> src/on.ts#L12 <summary># OnGetter </summary> src/on.ts#L13 <summary># Task </summary> src/task.ts#L17 <summary># MouseButton = ... </summary> src/constants.ts#L1 <summary># Task(fn, self, args) </summary> src/task.ts#L17
<summary># fn </summary> <summary># self </summary> <summary># args </summary> Task(fn, self, args) =>
<summary># abort(fn) </summary> src/abort.ts#L10
<summary># fn(signal) </summary>
<summary># signal </summary> fn(signal) =>
abort<P, R>(fn) =>
Fn<P, R extends Promise<any> ? R : Promise<R>>
<summary># chain(rest) </summary> src/helpers.ts#L3
<summary># rest </summary> chain(rest) =>
<summary># rest </summary> chain(rest) =>
<summary># dispatch(el, nameOrEvent, detail, init) </summary> src/dispatch.ts#L19
<summary># el </summary> <summary># nameOrEvent </summary> Narrow<K, string> | Event
<summary># detail </summary> DetailOf<T, template-literal>
<summary># init </summary> dispatch<T extends EventTarget, K>(el, nameOrEvent, detail, init) =>
<summary># dispatchBind(el) </summary> src/dispatch.ts#L29 <summary># event(fn) </summary> src/event.ts#L74
<summary># fn = ... </summary> event<T extends Target, E extends Event>(fn) =>
Fn<[ named-tuple-member ], any>
<summary># on(el) </summary> src/on.ts#L78
<summary># el </summary> on<T extends EventTarget>(el) =>
<summary># el </summary> <summary># key </summary> on<T extends EventTarget, K>(el, key) =>
<summary># onAll(target, listener, args) </summary> src/helpers.ts#L17
<summary># target </summary> <summary># listener </summary> <summary># args </summary> onAll(target, listener, args) =>
<summary># queue(queueFn) </summary> src/queue.ts#L252
<summary># queueFn </summary> queue<P, R>(queueFn) =>
Fn<P, R extends Promise<any> ? R : Promise<R>>
<summary># taskGroup(other, tasks) </summary> src/task.ts#L30
<summary># other </summary> <summary># tasks </summary> taskGroup(other, tasks) =>
<summary># taskRun(task, res) </summary> src/task.ts#L23
<summary># task </summary> <summary># res </summary> taskRun(task, res) =>
<summary># wrapEvent(options) </summary> src/event.ts#L16
<summary># options = ... </summary> wrapEvent(options) =>
<summary># (fn) </summary>
<summary># fn = ... </summary> <T extends Target, E extends Event>(fn) =>
Fn<[ named-tuple-member ], any>
<summary># wrapQueue(options) </summary> src/queue.ts#L29
<summary># options = {} </summary> wrapQueue(options) =>
<summary># (queueFn) </summary>
<summary># queueFn </summary> <P, R>(queueFn) =>
Fn<P, R extends Promise<any> ? R : Promise<R>>
Credits
Contributing
Fork or edit and submit a PR.
All contributions are welcome!
License
MIT © 2023 stagas
stagas