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

adjoin

v0.1.1

Published

ES6 component for adjoining one function to another in an Aspect-Oriented style

Downloads

8

Readme

Adjoin.js npm version license type npm downloads ECMAScript 6 & 5

Quality-controlled component for adjoining one function to another in an Aspect-Oriented style.

// ES6
import adjoin from "adjoin";

/**
 * Start with an empty context to exemplify
 */
let context = {};

/**
 * Start with a function that accepts zero or more arguments
 */
function originalFunction(argOne, argTwo) {
	this.original = argOne;
	// this.both was already set in beforeFunction
	this.both = this.both + argTwo;
}

/**
 * Create another function with the same
 * arguments and optional callback.
 */
function beforeFunction(argOne, argTwo) {
	this.before = argOne + 10;
	this.both = argOne + argTwo;
}

/**
 * Adjoin functions together into a new function
 */
const adjoinedFunction = adjoin.before(
	originalFunction,
	beforeFunction,
	context
);

/**
 * The adjoined function calls both functions
 * in the correct order, with the specified
 * arguments and context.
 */
adjoinedFunction(100, 200);

console.log(context); // {original:100, before:110, both:500}

Quality and Compatibility

Build Status Code Climate Dependency Status Dev Dependency Status

Every build and release is automatically tested on the following platforms:

node 0.12.x node 0.11.x node 0.10.x iojs 2.x.x iojs 1.x.x

Sauce Test Status

If your platform is not listed above, you can test your local environment for compatibility by copying and pasting the following commands into your terminal:

npm install adjoin
cd node_modules/adjoin
gulp test-local

Installation

Copy and paste the following command into your terminal to install Adjoin:

npm install adjoin --save

Import / Require

// ES6
import adjoin from "adjoin";
// ES5
var adjoin = require("adjoin");
// Require.js
define(["require"] , function (require) {
    var adjoin = require("adjoin");
});

Getting Started

Adjoin.js takes two functions and adjoins then together to form a new function that calls both with the same arguments, in order.

There are currently two ways to adjoin one function to another:

  • adjoin.before(originalFunction, beforeFunction, [context])
  • adjoin.after(originalFunction, afterFunction, [context])

Both methods support asynchronous functions, and node-style asynchronous functions with a callback as the last argument.

adjoin.before()

Return an adjoinedFunction that first calls beforeFunction, then calls originalFunction with the supplied arguments. Synchronous and node-style asynchronous functions are supported.

Synchronous Example:

// ES6
import adjoin from "adjoin";

/**
 * Start with an empty context to exemplify
 */
let context = {};

/**
 * Start with a function that accepts zero or more arguments
 */
function originalFunction(argOne, argTwo) {
	this.original = argOne;
	// this.both was already set in beforeFunction
	this.both = this.both + argTwo;
}

/**
 * Create another function with the same
 * arguments and optional callback.
 */
function beforeFunction(argOne, argTwo) {
	this.before = argOne + 10;
	this.both = argOne + argTwo;
}

/**
 * Adjoin functions together into a new function
 */
const adjoinedFunction = adjoin.before(
	originalFunction,
	beforeFunction,
	context
);

/**
 * The adjoined function calls both functions
 * in the correct order, with the specified
 * arguments and context.
 */
adjoinedFunction(100, 200);

console.log(context); // {original:100, before:110, both:500}

Node-style asynchronous Example:

// ES6
import adjoin from "adjoin";

/**
 * Start with an empty context to exemplify
 */
let context = {};

/**
 * Start with a function that accepts zero or 
 * more arguments, and optionally a callback
 */
function originalFunction(argOne, argTwo, callback) {
	this.original = argOne;
	this.both = argOne + argTwo;
	callback();
}

/**
 * Create another function with the same
 * arguments and optional callback.
 */
function beforeFunction(argOne, argTwo, callback) {
	this.before = argOne + 10;
	// this.both was already set in originalFunction
	this.both = this.both + argTwo;
	callback();
}

/**
 * Adjoin functions together into a new function
 */
const adjoinedFunction = adjoin.before(
	originalFunction,
	beforeFunction,
	context
);

/**
 * The adjoined function calls both functions
 * in the correct order, with the specified
 * arguments and context.
 */
adjoinedFunction(100, 200, () => {
	console.log(context); // {original:100, before:110, both:500}
});

adjoin.after()

Return an adjoinedFunction that first calls originalFunction, then calls afterFunction with the supplied arguments. Synchronous and node-style asynchronous functions are supported.

Synchronous Example:

// ES6
import adjoin from "adjoin";

/**
 * Start with an empty context to exemplify
 */
let context = {};

/**
 * Start with a function that accepts zero or more arguments
 */
function originalFunction(argOne, argTwo) {
	this.original = argOne;
	this.both = argOne + argTwo;
}

/**
 * Create another function with the same
 * arguments and optional callback.
 */
function afterFunction(argOne, argTwo) {
	this.after = argOne + 10;
	// this.both was already set in originalFunction
	this.both = this.both + argTwo;
}

/**
 * Adjoin functions together into a new function
 */
const adjoinedFunction = adjoin.after(
	originalFunction,
	afterFunction,
	context
);

/**
 * The adjoined function calls both functions
 * in the correct order, with the specified
 * arguments and context.
 */
adjoinedFunction(100, 200);

console.log(context); // {original:100, after:110, both:500}

Node-style asynchronous Example:

// ES6
import adjoin from "adjoin";

/**
 * Start with an empty context to exemplify
 */
let context = {};

/**
 * Start with a function that accepts zero or 
 * more arguments, and optionally a callback
 */
function originalFunction(argOne, argTwo, callback) {
	this.original = argOne;
	this.both = argOne + argTwo;
	callback();
}

/**
 * Create another function with the same
 * arguments and optional callback.
 */
function afterFunction(argOne, argTwo, callback) {
	this.after = argOne + 10;
	// this.both was already set in originalFunction
	this.both = this.both + argTwo;
	callback();
}

/**
 * Adjoin functions together into a new function
 */
const adjoinedFunction = adjoin.after(
	originalFunction,
	afterFunction,
	context
);

/**
 * The adjoined function calls both functions
 * in the correct order, with the specified
 * arguments and context.
 */
adjoinedFunction(100, 200, () => {
	console.log(context); // {original:100, after:110, both:500}
});

How to Contribute

See something that could use improvement? Have a great feature idea?

You can submit your ideas through our issues system, or make the modifications yourself and submit them to us in the form of a GitHub pull request.

We always aim to be friendly and helpful.

Running Tests

It's easy to run the test suite locally, and highly recommended if you're using Adjoin.js on a platform we aren't automatically testing for.

npm test