npm package discovery and stats viewer.

Discover Tips

  • General search

    [free text search, go nuts!]

  • Package details

    pkg:[package-name]

  • User packages

    @[username]

Sponsor

Optimize Toolset

I’ve always been into building performant and accessible sites, but lately I’ve been taking it extremely seriously. So much so that I’ve been building a tool to help me optimize and monitor the sites that I build to make sure that I’m making an attempt to offer the best experience to those who visit them. If you’re into performant, accessible and SEO friendly sites, you might like it too! You can check it out at Optimize Toolset.

About

Hi, 👋, I’m Ryan Hefner  and I built this site for me, and you! The goal of this site was to provide an easy way for me to check the stats on my npm packages, both for prioritizing issues and updates, and to give me a little kick in the pants to keep up on stuff.

As I was building it, I realized that I was actually using the tool to build the tool, and figured I might as well put this out there and hopefully others will find it to be a fast and useful way to search and browse npm packages as I have.

If you’re interested in other things I’m working on, follow me on Twitter or check out the open source projects I’ve been publishing on GitHub.

I am also working on a Twitter bot for this site to tweet the most popular, newest, random packages from npm. Please follow that account now and it will start sending out packages soon–ish.

Open Software & Tools

This site wouldn’t be possible without the immense generosity and tireless efforts from the people who make contributions to the world and share their work via open source initiatives. Thank you 🙏

© 2024 – Pkg Stats / Ryan Hefner

dom-event-emit

v1.1.0

Published

A type-safe, flexible DOM event emitter for browser environments. It has the same event API as DOM elements.

Downloads

168

Readme

dom-event-emit

version codecov downloads size browser license

A type-safe, flexible DOM event emitter for browser environments. It has the same event API as DOM elements.

适用于浏览器环境的 DOM 事件触发器,拥有和DOM元素相同的事件API。

Installation

npm

npm install dom-event-emit

browser

https://cdn.jsdelivr.net/npm/dom-event-emit/dist/index.min.js

Quick Start

import DomEmitter from 'dom-event-emit'

// Define your event types
interface MyEvents {
	'user:login': { userId: string; timestamp: number }
	'user:logout': void
}

// Create an instance
const events = new DomEmitter<MyEvents>()

// Add event listener
events.on('user:login', (event) => {
	console.log(`User logged in: ${event.detail.userId}`)
})

// Emit event
events.emit('user:login', { userId: '123', timestamp: Date.now() })

API

Constructor

constructor(target?: HTMLElement)

Creates a new DomEmitter instance.

  • target (optional): HTMLElement to attach events to. If not provided, creates a virtual element.

Methods

addEventListener / on

addEventListener<K extends keyof T>(
  type: K,
  listener: EventListener,
  options?: boolean | AddEventListenerOptions
): this

Adds an event listener.

  • type: Event type
  • listener: Event handler function
  • options: DOM event options (optional)

removeEventListener / off

removeEventListener<K extends keyof T>(
	type: K,
	listener: CustomEventListener,
	options?: boolean | EventListenerOptions
): this

Removes an event listener.

once

once<K extends keyof T>(
	type: K,
	listener: CustomEventListener,
	options?: boolean | EventListenerOptions
): this

Adds a one-time event listener.

dispatchEvent

dispatchEvent<K extends keyof T>(event: Event, data?: Partial<T[K]>): boolean

Dispatches a raw DOM event.

emit

emit<K extends keyof T>(
	type: K,
	detail?: any,
	data?: Partial<T[K]>
): boolean
  • type: Event type
  • detail: Event detail data
  • data: Additional event data (optional)

Emits an event with optional data.

🚨 It also trigger events bind by assigning on + type to the instance.

has

has(type: string, includeOn = false): boolean

Checks if an event type has any listeners.

size

size(type: string, includeOn = false): number

Gets the number of listeners for an event type.

clear

clear(type?: string): void

Clears all listeners for a specific event type or all events.

destroy

destroy(): void

Destroys the instance and removes all listeners.

License

MIT

Contributing

Contributions are welcome! Please feel free to submit a Pull Request.