πŸ¦„ Like polyfill but with pony pureness
Latest commit 5454fd7 Oct 8, 2016 @SamVerschueren SamVerschueren committed with fix typo (#5)
Permalink
Failed to load latest commit information.
media init Sep 29, 2016
.editorconfig init Sep 29, 2016
.gitattributes init Sep 29, 2016
readme.md fix typo (#5) Oct 8, 2016

readme.md

Ponyfill

Like polyfill but with pony pureness




Use ponyfill.com for linking here.

Pony pureness, really?

While polyfills are naughty, ponyfills are pure, just like ponies.

How are ponyfills better than polyfills?

A polyfill is code that adds missing functionality by monkey patching an API. Unfortunately, it usually globally patches built-ins, which affects all code running in the environment. This is especially problematic when a polyfill is not fully spec compliant (which in some cases is impossible), as it could cause very hard to debug bugs and inconsistencies. Or when the spec for a new feature changes and your code depends on behavior that a module somewhere else in the dependency tree polyfills differently. In general, you should not modify API's you don't own.

A ponyfill, in contrast, doesn't monkey patch anything, but instead exports the functionality as a normal module, so you can use it locally without affecting other code.

tl;dr; Polyfills are naughty as they patch native APIs, while ponyfills are pure and don't affect the environment.

Polyfill

Number.isNaN = Number.isNaN || function (value) {
	return value !== value;
};
require('is-nan-polyfill');

Number.isNaN(5);

Ponyfill

module.exports = function (value) {
	return value !== value;
};
var isNanPonyfill = require('is-nan-ponyfill');

isNanPonyfill(5);

Ponyfills should never use the native API, even if available, as it might have slightly different behavior between environments, which can cause bugs.

Where can I find ponyfills?

Search npm.

How do I make a ponyfill?

  • Read the specification or source code of the feature you want to ponyfill.
  • Initialize an npm package.
  • Write some tests to ease writing the ponyfill logic.
  • Link to documentation about the feature in your readme. Example.
  • Link to https://ponyfill.com in your readme. Example.
  • Add ponyfill to the keywords section in package.json.
  • Publish!

Resources

License

CC0

To the extent possible under law, Sindre Sorhus has waived all copyright and related or neighboring rights to this work.

Header based on work by Mary Winkler.