Logo for jsDocs.io

component-emitter

  • Version 2.0.0
  • Published
  • 9.57 kB
  • No dependencies
  • MIT license

Install

npm i component-emitter
yarn add component-emitter
pnpm add component-emitter

Overview

Simple event emitter

Index

Variables

Variables

variable emitter

const emitter: EmitterConstructor;

  • As an Emitter instance:

    import Emitter from 'component-emitter';
    

    const emitter = new Emitter();
    

    emitter.emit('🦄');

    As a mixin:

    import Emitter from 'component-emitter';
    

    const user = {name: 'tobi'};
    Emitter(user);
    

    user.emit('I am a user');

    As a prototype mixin:

    import Emitter from 'component-emitter';
    

    Emitter(User.prototype);

Package Files (1)

Dependencies (0)

No dependencies.

Dev Dependencies (2)

Peer Dependencies (0)

No peer dependencies.

Badge

To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/component-emitter.

  • Markdown
    [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/component-emitter)
  • HTML
    <a href="https://www.jsdocs.io/package/component-emitter"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>