evee.js - GitLite

KO | EN

gitlite — search

#privacy #swift #tensorflow #nlp #css #java #json #agents #php #markdown

evee.js

(★ 195)

The lightweight es6 event library.

File Explorer

ZIP Download

- basic.js
- evee.js
.babelrc
.gitignore
.travis.yml
benchmark.js
LICENSE.md
package-lock.json
package.json
README.md
test.js

# Use via CDN

jsDelivr

jsDelivr serves any public GitHub repository as a CDN with zero setup. Pick a version and a file to get a ready-to-paste link and snippet.

Version

File

Link

Example

Command Glossary

Commands referenced in this DOCs, explained below.

🔍

`npm install`

View Details ▼

Install Node packages.

npm {{[i|install]}}

Install dependencies listed in `package.json`:

npm {{[i|install]}} {{package_name}}@{{version}}

Download a specific version of a package and add it to the list of dependencies in `package.json`:

npm {{[i|install]}} {{package_name}} {{[-D|--save-dev]}}

Download the latest version of a package and add it to the list of dev dependencies in `package.json`:

🔍

`yarn`

View Details ▼

JavaScript and Node.js package manager alternative.

yarn global add {{module_name}}

Install a module globally:

yarn install

Install all dependencies referenced in the `package.json` file (the `install` is optional):

yarn add {{module_name}}@{{version}}

Install a module and save it as a dependency to the `package.json` file (add `--dev` to save as a dev dependency):

🔍

`script`

View Details ▼

Record all terminal output to a typescript file.

script

Record a new session to a file named `typescript` in the current directory:

exit

Stop recording:

script {{path/to/session.out}}

Record a new session to a custom filepath:

// repository documentation

Was this content helpful?

★ 0 (0 ratings)

[![MIT License](https://badgers.space/github/license/SplittyDev/evee.js)](https://raw.githubusercontent.com/SplittyDev/evee.js/master/LICENSE.md)
[![Evee on NPM](https://badgers.space/npm/name/evee)](https://npmjs.com/package/evee)

The blazing fast event library 🔥

Evee is a lightweight event library, written in just ~200 lines of JavaScript.  
Evee exports ESM, CommonJS and Browser globals, so you can use it in any environment.

## How to install
```sh
npm install evee # if you're using NPM
yarn add evee # if you're using Yarn
```

## Introducing Evee 3
Evee now natively supports ESM and CommonJS.

We export two things:
- `Evee` (default export): The class you can use to create new instances of Evee.
- `evee` (named export): A pre-made instance of Evee so you can immediately start using it.

If you're planning to use Evee in NodeJS, you can now import it like this:
```js
import Evee, { evee } from 'evee'; // If you're using ESM (import/export)
const { default: Evee, evee } = require('evee'); // If you're using CommonJS (require)
```

If you're planning to use Evee in the browser, you can now import it like this:
```html

<script type="module">
  import Evee, { evee } from 'https://cdn.jsdelivr.net/npm/evee@3';
</script>

<script src="https://cdn.jsdelivr.net/npm/evee@3/dist/browser/index.min.js"></script>
<script>
  // You can use the `Evee` (class) and `evee` (instance) globals here
</script>
```

## How to use
```js
import { evee } from 'evee'

// Subscribe to the 'update' event
evee.on('update', e => console.log(`Received event #${e.data}`))

for (let i = 0; i < 100; i++) {

// Dispatch the 'update' event
  evee.emit('update', i);
}
```

You can also keep track of your event listeners unsubscribe from events you don't need anymore.

```js
import { evee } from 'evee'

// Subscribe to the 'say' event
var receiver = evee.on('say', e => console.log(e.data));

// Dispatch the 'say' event
evee.emit('say', 'Hello, world!');

// Unsubscribe from the 'say' event
evee.drop(receiver);
```

If you want to fire an event only once, you can do that too!   
The event will be automatically removed after the first usage:

```js
import { evee } from 'evee'

// Subscribe to the 'say' event
evee.once('say', e => console.log('hello, world'));

// Dispatch the 'say' event two times
evee.signal('say');
evee.signal('say');

// hello, world is only printed once!
```

As you can see, evee is really easy to use!   
Start using evee today and stop worrying about slow events :)