How to use nanoevents with TypeScript?

Define an interface for event types and pass it to `createNanoEvents ()` for type-safe emit and on calls, as shown in the README's TypeScript section, ensuring compile-time checks for event arguments.

What's the difference between nanoevents and Node.js EventEmitter?

Nano Events is much smaller (108 bytes vs. Node.js's larger size) and has a simpler API with only emit and on, while Node.js EventEmitter includes features like once, removeAllListeners, and error handling, but adds compatibility overhead.

How to remove all listeners in nanoevents?

You can set the `events` property to an empty object, like `emitter.events = {}`, as mentioned in the 'Remove All Listeners' section of the README, but this is a manual approach without a dedicated method.

Can I use nanoevents in Node.js projects?

Yes, it works in Node.js environments with ES modules support, but it doesn't provide Node.js EventEmitter compatibility, so you may need adapters if integrating with existing Node.js codebases.

Nano Events vs Mitt: which is better for small projects?

Both are minimal event emitters; Nano Events is slightly smaller (108 bytes vs. Mitt's ~200 bytes) and has a cleaner unbinding API, but Mitt is more popular and might have better community support for some use cases.

How to implement a once listener in nanoevents?

Create a custom method that binds a listener, calls unbind after the first emit, and invokes the callback, as demonstrated in the README's 'Once' section, which requires extra code compared to built-in solutions.

nanoevents — 108-Byte JavaScript Event Emitter

What is nanoevents?

Nano Events is a minimal event emitter library for JavaScript that provides a simple API for managing custom events. It solves the problem of adding event-driven architecture to applications without the overhead of larger libraries, focusing on a tiny code footprint and developer convenience.

Target Audience

JavaScript and TypeScript developers who need a lightweight, no-frills event system for frontend applications, Node.js projects, or libraries where bundle size is critical.

Value Proposition

Developers choose Nano Events for its extreme minimalism (108 bytes), clean API that eliminates callback reference management, and first-class TypeScript support, making it ideal for performance-sensitive projects.

Simple and tiny (107 bytes) event emitter library for JavaScript

Use Cases

Best For

Adding event-driven patterns to lightweight JavaScript libraries
Projects where bundle size optimization is a top priority
TypeScript applications requiring type-safe event handling
Building custom class-based event systems with minimal overhead
Educational projects demonstrating event emitter implementation
Replacing bulky event libraries in performance-critical applications

Not Ideal For

Projects requiring built-in 'once' event listeners without custom implementation
Teams that need Node.js EventEmitter compatibility for interoperability with existing Node.js modules
Applications where advanced event features like wildcard matching or error handling are essential

Pros & Cons

Pros

Ultra-Small Size

At only 108 bytes minified and brotlied, it has negligible impact on bundle size, controlled via Size Limit, making it ideal for performance-critical projects.

Convenient Unbinding

The `on` method returns an `unbind` function, eliminating the need to store callback references for removal, simplifying listener management as shown in the README examples.

TypeScript Integration

Full TypeScript support with event type mapping provides compile-time safety for event names and arguments, reducing runtime errors, as demonstrated in the TypeScript section.

Simple API

With just `emit` and `on` methods, the API is focused and straightforward, avoiding aliases and Node.js EventEmitter compatibility overhead for minimal complexity.

Cons

Missing Advanced Features

It lacks built-in utilities like 'once' listeners and a proper removeAllListeners method, requiring manual implementation as admitted in the README's 'Once' and 'Remove All Listeners' sections.

Limited Ecosystem

Being minimal, it offers no plugins or extended features such as error handling or wildcard events, so additional functionality must be built from scratch.

Manual Setup for Extensions

Adding common features like once listeners involves writing custom code, which can increase development overhead compared to more comprehensive libraries.

What is nanoevents?

Target Audience

JavaScript and TypeScript developers who need a lightweight, no-frills event system for frontend applications, Node.js projects, or libraries where bundle size is critical.

Value Proposition

Use Cases

Best For

Adding event-driven patterns to lightweight JavaScript libraries
Projects where bundle size optimization is a top priority
TypeScript applications requiring type-safe event handling
Building custom class-based event systems with minimal overhead
Educational projects demonstrating event emitter implementation
Replacing bulky event libraries in performance-critical applications

Not Ideal For

Projects requiring built-in 'once' event listeners without custom implementation
Teams that need Node.js EventEmitter compatibility for interoperability with existing Node.js modules
Applications where advanced event features like wildcard matching or error handling are essential

Pros & Cons

Pros

Ultra-Small Size

At only 108 bytes minified and brotlied, it has negligible impact on bundle size, controlled via Size Limit, making it ideal for performance-critical projects.

Convenient Unbinding

The `on` method returns an `unbind` function, eliminating the need to store callback references for removal, simplifying listener management as shown in the README examples.

TypeScript Integration

Full TypeScript support with event type mapping provides compile-time safety for event names and arguments, reducing runtime errors, as demonstrated in the TypeScript section.

Simple API

With just `emit` and `on` methods, the API is focused and straightforward, avoiding aliases and Node.js EventEmitter compatibility overhead for minimal complexity.

Cons

Missing Advanced Features

It lacks built-in utilities like 'once' listeners and a proper removeAllListeners method, requiring manual implementation as admitted in the README's 'Once' and 'Remove All Listeners' sections.

Limited Ecosystem

Being minimal, it offers no plugins or extended features such as error handling or wildcard events, so additional functionality must be built from scratch.

Manual Setup for Extensions

Adding common features like once listeners involves writing custom code, which can increase development overhead compared to more comprehensive libraries.

nanoevents

What is nanoevents?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?

nanoevents

What is nanoevents?

Overview

Use Cases

Best For

Not Ideal For

Pros & Cons

Pros

Cons

Frequently Asked Questions

Related Projects

Found a gem we're missing?