1.3.1 • Published 3 years ago

event-toolkit

Licence

MIT

Version

1.3.1

Deps

4

Size

280 kB

Vulns

0

Weekly

0

Summary Dependency Versions

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()

# 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()

# 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

# 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

# constructor()

# new OnOptions()

# atomic = bool

src/queue.ts#L20

boolean

# capture = bool

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

# immediate = bool

src/event.ts#L10

boolean

# last = bool

src/queue.ts#L13

boolean

# next = bool

src/queue.ts#L14

boolean

# once = bool

boolean

# passive = bool

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()

# 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

# 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

# event

E & {

# currentTarget

# 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

false

# Dispatch

src/dispatch.ts#L10

T & Fluent<T, Required<DispatchOptions>>

# Fn

# (args)

# args

(args) =>

# Off

# ()

() =>

void

# On

T & Fluent<T, Required<OnOptions>>

# OnEvent

On<Fn<[ optional ], Off>>

# OnGetter

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

# Task

src/task.ts#L17

{

# args

any

# fn

Fn<any, any>

# promise

Promise<any>

# reject

Fn<any, any>

# resolve

Fn<any, any>

# self

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) =>

# abort(fn)

src/abort.ts#L10

# fn(signal)

# signal

AbortSignal

fn(signal) =>

abort<P, R>(fn) =>

Promise

R

Promise

# chain(rest)

src/helpers.ts#L3

# rest

AnyFn [] | AnyFn [] []

chain(rest) =>

# ()

() =>

any

# rest

chain(rest) =>

# ()

() =>

any

# dispatch(el, nameOrEvent, detail, init)

src/dispatch.ts#L19

# el

# 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

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) =>

# on(el)

# el

on<T extends EventTarget>(el) =>

# el

# key

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

# 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) =>

Promise

R

Promise

# taskGroup(other, tasks)

src/task.ts#L30

# other

# tasks

taskGroup(other, tasks) =>

void

# taskRun(task, res)

src/task.ts#L23

# task

# res

any

taskRun(task, res) =>

any

# wrapEvent(options)

src/event.ts#L16

# options = ...

wrapEvent(options) =>

# (fn)

# fn = ...

EventHandler<T, E>

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

# wrapQueue(options)

src/queue.ts#L29

# options = {}

Partial<QueueOptions>

wrapQueue(options) =>

# (queueFn)

# queueFn

Fn<P, R>

<P, R>(queueFn) =>

Promise

R

Promise

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