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

is-pure-function

v1.0.4

Published

Return true, if function is pure.

Downloads

10

Readme

is-pure-function

NPM version dependencies License MIT

NPM

Simple and fast ES3-check that function is pure.

/** 
 * @param {function} fn
 * @param {*} thisArg
 * @param {Array} args
 * @return {boolean}
 */
function isPureFunction(fn, thisArg, args) {/**...*/};

fn is pure, if not throw when called with thisArg as this and args as arguments in global scope.

Pure function cannot use closures, but can use exists global vars (Array, Object, setTimeout, etc.). Pure function should not have side effects, and cannot throw exceptions. Arrow function may be pure, but then it should not contain 'this' and 'arguments' words. Generators could not be pure (always product new iterator). Result of Function.prototype.bind() could not be pure (because we can not substitute the required value of this).

It is supposed to use in reactive libraries.

Examples

var isPureFunction = require('is-pure-function');

function f(a, b) {
  return a + b;
}
// true
isPureFunction(f, null, [1, 2]);


var g = function(a) {
  return function(b) {
    return a + b;
  }
}(1);
// false (use closure var)
isPureFunction(g, {}, [1, 2]);


function getIndex(str, char) {
  return str.indexOf(char);
}
// false (wrong type of arguments)
isPureFunction(getIndex, null, [1, 2]);
// true
isPureFunction(getIndex, null, ['str', 'c']);


var f1 = function(a) {return a;}
// false (extra arguments)
isPureFunction(f1, undefined, [1, 2]);
// false (not enough arguments)
isPureFunction(f1, undefined, []);
// true
isPureFunction(f1, undefined, [1]);
// throw ReferenceError, missing argument
isPureFunction(f1, undefined);
// false (not a function at all)
isPureFunction({}, undefined, []);


var getThisA = function() {
  return this.a;
}
// false (ReferenceError)
isPureFunction(getThisA, null, []);
// true (this -- context-argument of function)
isPureFunction(getThisA, {}, []);


function* generator() {
  return yield null;
}
// false
isPureFunction(generator, 0, []);


var arrow = (a, b) => a + b;
// true
isPureFunction(arrow, '', [1, 2]);


var arrowThis = () => this;
// false (this bound in arrow functions)
isPureFunction(arrowThis, 0, []);

// but
var arrowStr = () => 'this';
//true
isPureFunction(arrowStr, 0, []);


var arrowArgs = () => arguments;
// false (this bound in arrow functions)
isPureFunction(arrowArgs, null, []);

// but
var arrowComment = () => {
  // arguments
  return 3;
}
// true
isPureFunction(arrowComment, null, []);


var boundFn = function() {}.bind();
// false (can not substitute the required value of this)
isPureFunction(boundFn, 0, []);

// it is unlikely you will need
isPureFunction.clearCache();

Use pure functions for FRP (the best way is arrow functions, without this and arguments object, with a fixed number of arguments).

Tests

Standalone pages test/es3.html && test/es6.html (via Mocha). Install webpack and opener, build scripts, than run tests:

$ npm install
$ npm run build
$ npm test

License

MIT