sparkles

WebJar for sparkles

License	MIT
GroupId	org.webjars.npm
ArtifactId	sparkles
Last Version	1.0.1
Release Date	Aug 22, 2018
Type	jar
Description	sparkles WebJar for sparkles
Project URL	http://webjars.org
Source Code Management	https://github.com/gulpjs/sparkles

Download sparkles

Filename	Size
sparkles-1.0.1.pom
sparkles-1.0.1.jar	4 KB
sparkles-1.0.1-sources.jar	22 bytes
sparkles-1.0.1-javadoc.jar	22 bytes

How to add to project

Apache Maven

<!-- https://jarcasting.com/artifacts/org.webjars.npm/sparkles/ -->
<dependency>
    <groupId>org.webjars.npm</groupId>
    <artifactId>sparkles</artifactId>
    <version>1.0.1</version>
</dependency>

Gradle Groovy

// https://jarcasting.com/artifacts/org.webjars.npm/sparkles/
implementation 'org.webjars.npm:sparkles:1.0.1'

Gradle Kotlin

// https://jarcasting.com/artifacts/org.webjars.npm/sparkles/
implementation ("org.webjars.npm:sparkles:1.0.1")

Apache Buildr

'org.webjars.npm:sparkles:jar:1.0.1'

Apache Ivy

<dependency org="org.webjars.npm" name="sparkles" rev="1.0.1">
  <artifact name="sparkles" type="jar" />
</dependency>

Groovy Grape

@Grapes(
@Grab(group='org.webjars.npm', module='sparkles', version='1.0.1')
)

Scala SBT

libraryDependencies += "org.webjars.npm" % "sparkles" % "1.0.1"

Leiningen

[org.webjars.npm/sparkles "1.0.1"]

Dependencies

There are no dependencies for this project. It is a standalone project that does not depend on any other jars.

Project Modules

There are no modules declared in this project.

sparkles

Namespaced global event emitter

Usage

Sparkles exports a function that returns a singleton EventEmitter. This EE can be shared across your application, whether or not node loads multiple copies.

Note: If you put an event handler in a file in your application, that file must be loaded in via an import somewhere in your application, even if it's not directly being used. Otherwise, it will not be loaded into memory.

var sparkles = require('sparkles')(); // make sure to call the function

sparkles.on('my-event', function(evt){
  console.log('my-event handled', evt);
});

sparkles.emit('my-event', { my: 'event' });

API

sparkles(namespace)

Returns an EventEmitter that is shared amongst the provided namespace. If no namespace is provided, returns a default EventEmitter.

sparkles.exists(namespace);

Checks whether a namespace exists and returns true or false.

Why the name?

This is a "global emitter"; shortened: "glitter" but it was already taken; so we got sparkles instead 😄

License

MIT

gulp

A toolkit to automate & enhance your workflow

Versions

Version
1.0.1 Aug 22, 2018
1.0.0 Nov 22, 2016