Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/walling/Function.create.js
Create named functions easily in JavaScript.
https://github.com/walling/Function.create.js
Last synced: about 2 months ago
JSON representation
Create named functions easily in JavaScript.
- Host: GitHub
- URL: https://github.com/walling/Function.create.js
- Owner: walling
- Created: 2013-02-15T23:29:18.000Z (over 11 years ago)
- Default Branch: master
- Last Pushed: 2013-02-17T00:24:47.000Z (over 11 years ago)
- Last Synced: 2024-07-02T15:49:48.968Z (3 months ago)
- Language: JavaScript
- Homepage:
- Size: 160 KB
- Stars: 7
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: Readme.md
Awesome Lists containing this project
- es6-tools - `Function.create`
README
Function.create
===============
This allows you to create named functions easily in JavaScript. Tested browsers:
* IE 8
* Chrome
* Firefox
* Safari
It is similar to the [sketched `Function.create`](http://wiki.ecmascript.org/doku.php?id=strawman:name_property_of_functions) in ECMAScript (two years old). The proposal was never accepted, so this function is not based on any standards, but it's still very useful.
Getting Started
---------------
Download:
* [Development Version](https://raw.github.com/walling/Function.create.js/master/Function.create.js) (16kb, Uncompressed with Plentiful Comments)
* [Production Version](https://raw.github.com/walling/Function.create.js/master/Function.create.min.js) (4kb, Minified and Gzipped)
* [Production Version without Unicode support](https://raw.github.com/walling/Function.create.js/master/Function.create.no-unicode.min.js) (1kb, Minified and Gzipped)
Installing:
```
npm install function.create
```
Loading it in Node.JS:
```javascript
require('function.create'); // now loaded globally
```
Loading it in the browser:
```html
```
Usage
-----
Two functions are provided:
* **Function**.create(name, call[, construct[, proto]])
* **Function**.getDisplayNameOf(f)
The `proto` argument sets the prototype of the newly created function. This is available in all browsers except MSIE, where it is simulated by copying the whole prototype chain.
Example 1 (creating unnamed function):
```javascript
var anon = Function.create(null, function(str) {
console.log('anon called:', str);
});
anon('Hello, anon!');
```
Example 2 (creating simple named function):
```javascript
var simple = Function.create('simple', function(str) {
console.log('simple called:', str);
});
console.log(simple.name); // "simple"
simple('Hello, simple!');
```
Example 3 (creating simple named constructor):
```javascript
var Constr = Function.create('Constr', function(n) {
this.n = n;
});
Constr.prototype.say = function(text) {
console.log('say: ' + text + ', ' + this.n + '!');
};
console.log(Constr.name); // "Constr"
var c = new Constr('simple named constructor');
c.say('Bonjour'); // say: Bonjour, simple named constructor!
```
Example 4 (creating named function and constructor):
```javascript
var Person = Function.create('Person', function(name) {
return new Person(name);
}, function(name) {
this.name = name;
});
console.log(Person.name); // "Person"
var p1 = new Person('Bobby');
var p2 = Person('Bobby');
console.log('Same person?', p1.name === p2.name); // true
```
Example 5 (getting name of function):
```javascript
var func = function fancyFunction() {};
console.log('Function name:', Function.getDisplayNameOf(func));
```
Example 6 (named classes):
```javascript
function createClass(name, properties) {
var Class = Function.create(name, function() {
if (typeof(this.initialize) === 'function') {
this.initialize.apply(this, arguments);
}
});
Class.prototype = properties;
Class.prototype.constructor = Class;
return Class;
}
var Person = createClass('Person', {
initialize: function(name) {
this.name = name;
},
getName: function() {
return this.name;
}
});
var andy = new Person('Andy');
console.log(andy instanceof Person); // true
console.log(andy.getName()); // "Andy"
```
Example 7 (functor, or the story about function inheriting object):
```javascript
function createFunctor(name, properties) {
return Function.create(name, function() {
if (typeof(this.invoke) === 'function') {
this.invoke.apply(this, arguments);
}
}, null, properties);
}
function Module() {}
Module.prototype = new Function();
Module.prototype.constructor = Module;
Module.prototype.say = function(message) {
console.log('I want to say: ' + message);
};
Module.prototype.invoke = function(a, b) {
this.say(a + ' + ' + b + ' = ' + (a + b));
return a + b;
};
var M = createFunctor('Module', new Module());
console.log(M.name); // "Module"
console.log(typeof(M)); // "function"
console.log(M instanceof Module); // true, in all browsers except MSIE
M(20, 22); // outputs "I want to say: 20 + 22 = 42"
```