event-toolkit

Toolkit for DOM events.

npm i event-toolkit

pnpm add event-toolkit

yarn add event-toolkit

API

# AbortOptions

src/abort.ts#L4

# constructor()

# new AbortOptions()

AbortOptions

# latest  =  bool

src/abort.ts#L6

boolean

# throw  =  bool

src/abort.ts#L5

boolean

# timeout

src/abort.ts#L7

number

# DispatchOptions

src/dispatch.ts#L4

# constructor()

# new DispatchOptions()

DispatchOptions

# bubbles  =  bool

src/dispatch.ts#L5

boolean

# cancelable  =  bool

src/dispatch.ts#L6

boolean

# composed  =  bool

src/dispatch.ts#L7

boolean

# EventOptions

src/event.ts#L7

# constructor()

# new EventOptions()

EventOptions

# atomic  =  bool

src/queue.ts#L20

boolean

# capture  =  bool

src/event.ts#L11

boolean

# concurrency

src/queue.ts#L21

number

# debounce

src/queue.ts#L23

number

# first  =  bool

src/queue.ts#L12

boolean

# hooks

src/queue.ts#L26

Hooks

# immediate  =  bool

src/event.ts#L10

boolean

# last  =  bool

src/queue.ts#L13

boolean

# next  =  bool

src/queue.ts#L14

boolean

# once  =  bool

src/event.ts#L12

boolean

# passive  =  bool

src/event.ts#L13

boolean

# prevent  =  bool

src/event.ts#L8

boolean

# raf  =  bool

src/queue.ts#L16

boolean

# stop  =  bool

src/event.ts#L9

boolean

# task  =  bool

src/queue.ts#L17

boolean

# throttle

src/queue.ts#L24

number

# time  =  bool

src/queue.ts#L18

boolean

# OnOptions

src/on.ts#L15

# constructor()

# new OnOptions()

OnOptions

# atomic  =  bool

src/queue.ts#L20

boolean

# capture  =  bool

src/on.ts#L18

boolean

# concurrency

src/queue.ts#L21

number

# debounce

src/queue.ts#L23

number

# first  =  bool

src/queue.ts#L12

boolean

# hooks

src/queue.ts#L26

Hooks

# immediate  =  bool

src/event.ts#L10

boolean

# last  =  bool

src/queue.ts#L13

boolean

# next  =  bool

src/queue.ts#L14

boolean

# once  =  bool

src/on.ts#L16

boolean

# passive  =  bool

src/on.ts#L17

boolean

# prevent  =  bool

src/event.ts#L8

boolean

# raf  =  bool

src/queue.ts#L16

boolean

# stop  =  bool

src/event.ts#L9

boolean

# task  =  bool

src/queue.ts#L17

boolean

# throttle

src/queue.ts#L24

number

# time  =  bool

src/queue.ts#L18

boolean

# QueueOptions

src/queue.ts#L11

# constructor()

# new QueueOptions()

QueueOptions

# atomic  =  bool

src/queue.ts#L20

boolean

# concurrency

src/queue.ts#L21

number

# debounce

src/queue.ts#L23

number

# first  =  bool

src/queue.ts#L12

boolean

# hooks

src/queue.ts#L26

Hooks

# last  =  bool

src/queue.ts#L13

boolean

# next  =  bool

src/queue.ts#L14

boolean

# raf  =  bool

src/queue.ts#L16

boolean

# task  =  bool

src/queue.ts#L17

boolean

# throttle

src/queue.ts#L24

number

# time  =  bool

src/queue.ts#L18

boolean

# EventHandler

# this

T

# event
E & {

# currentTarget

T

# target

Element

}

EventHandler(this, event)  =>

any

# Hooks

src/queue.ts#L6

# after

src/queue.ts#L8

# ()
()  =>

void

# before

src/queue.ts#L7

# ()
()  =>

void

# AnyFn

src/helpers.ts#L1

# (args)
# args

any []

(args)  =>

any

| void | false

# Dispatch

src/dispatch.ts#L10

T & Fluent<T, Required<DispatchOptions>>

# Fn

# (args)
# args

T

(args)  =>

R

# Off

src/on.ts#L10

# ()
()  =>

void

# On

src/on.ts#L11

T & Fluent<T, Required<OnOptions>>

# OnEvent

src/on.ts#L12

On<Fn<[ optional ], Off>>

# OnGetter

src/on.ts#L13

[K in EventKeys<T> ]: OnEvent<T, K>

# Task

src/task.ts#L17

{

# args

src/task.ts#L6

any

# fn

src/task.ts#L4

Fn<any, any>

# promise

src/task.ts#L7

Promise<any>

# reject

src/task.ts#L9

Fn<any, any>

# resolve

src/task.ts#L8

Fn<any, any>

# self

src/task.ts#L5

any

}

# MouseButton  =  ...

src/constants.ts#L1

{

# Left  =  1

src/constants.ts#L2

number

# Middle  =  4

src/constants.ts#L4

number

# Right  =  2

src/constants.ts#L3

number

}

# Task(fn, self, args)

src/task.ts#L17

# fn

Fn<any, any>

# self

any

# args

any

Task(fn, self, args)  =>

Task

# abort(fn)

src/abort.ts#L10

# fn(signal)
# signal

AbortSignal

fn(signal)  =>

Fn<P, R>

abort<P, R>(fn)  =>

Fn<P, R extends Promise<any> ? R : Promise<R>>

# chain(rest)

src/helpers.ts#L3

# rest

AnyFn [] | AnyFn [] []

chain(rest)  =>

# ()
()  =>

any
# rest

AnyFn []

chain(rest)  =>

# ()
()  =>

any

# dispatch(el, nameOrEvent, detail, init)

src/dispatch.ts#L19

# el

T

# nameOrEvent

Narrow<K, string> | Event

# detail

DetailOf<T, template-literal>

# init

CustomEventInit<any>

dispatch<T extends  EventTarget, K>(el, nameOrEvent, detail, init)  =>

any

# dispatchBind(el)

src/dispatch.ts#L29

# el

T

dispatchBind<T extends  EventTarget>(el)  =>

Fluent<
# (nameOrEvent, detail, init)
# nameOrEvent

Event | Narrow<K, string>

# detail

DetailOf<T, template-literal>

# init

CustomEventInit<any>

<K>(nameOrEvent, detail, init)  =>

any
, Required<DispatchOptions>>

# event(fn)

src/event.ts#L74

# fn  =  ...

EventHandler<T, E>

event<T extends  Target, E extends  Event>(fn)  =>

Fn<[ named-tuple-member ], any>

# on(el)

src/on.ts#L78

# el

T

on<T extends  EventTarget>(el)  =>

OnGetter<T>
# el

T

# key

K

on<T extends  EventTarget, K>(el, key)  =>

OnEvent<T, K>

# onAll(target, listener, args)

src/helpers.ts#L17

# target

EventTarget

# listener

EventListener

# args

any []

onAll(target, listener, args)  =>

# ()
()  =>

void

# queue(queueFn)

src/queue.ts#L252

# queueFn

Fn<P, R>

queue<P, R>(queueFn)  =>

Fn<P, R extends Promise<any> ? R : Promise<R>>

# taskGroup(other, tasks)

src/task.ts#L30

# other

Task

# tasks

Task []

taskGroup(other, tasks)  =>

void

# taskRun(task, res)

src/task.ts#L23

# task

Task

# res

any

taskRun(task, res)  =>

any

# wrapEvent(options)

src/event.ts#L16

# options  =  ...

EventOptions

wrapEvent(options)  =>

# (fn)
# fn  =  ...

EventHandler<T, E>

<T extends  Target, E extends  Event>(fn)  =>

Fn<[ named-tuple-member ], any>

# wrapQueue(options)

src/queue.ts#L29

# options  =  {}

Partial<QueueOptions>

wrapQueue(options)  =>

# (queueFn)
# queueFn

Fn<P, R>

<P, R>(queueFn)  =>

Fn<P, R extends Promise<any> ? R : Promise<R>>

Credits

• everyday-types by stagas – Everyday utility types
• everyday-utils by stagas – Everyday utilities
• proxy-toolkit by stagas – Proxy toolkit.
• to-fluent by stagas – Convert a function with a settings object to fluent API.

Contributing

Fork or edit and submit a PR.

All contributions are welcome!

License

MIT © 2023 stagas