@fav/prop.define

Defines object properities.

"fav" is an abbreviation of "favorite" and also the acronym of "for all versions". This package is intended to support all Node.js versions and many browsers as possible. At least, this package supports Node.js >= v0.10 and major Web browsers: Chrome, Firefox, IE11, Edge, Vivaldi and Safari.

Install

To install from npm:

$ npm install --save @fav/prop.define

NOTE: npm < 2.7.0 does not support scoped package, but old version Node.js supports it. So when you use such older npm, you should download this package from github.com, and move it in node_modules/@fav/prop.define/ directory manually.

Usage

For Node.js:

var define = require('@fav/prop.define');
var obj = {};

define.immutable(obj, 'HIDDEN_CONSTANT_VALUE', 123);
console.log(obj.HIDDEN_CONSTANT_VALUE); // => 123

define.mutable(obj, 'hiddenVariable', 456);
console.log(obj.hiddenVariable); // => 456

obj.func = function() {
  console.log(this.HIDDEN_CONSTANT_VALUE);
};
obj.func(); // => 123

define.override(obj, function func() {
  func.$uper();
  console.log(this.hiddenVariable);
});
obj.func();
// => 123
//    456

For Web browsers:

<script src="fav.prop.define.min.js"></script>
<script>
var define = fav.prop.define;
define.immutable(obj, 'HIDDEN_CONSTANT_VALUE', 123);
console.log(obj.HIDDEN_CONSTANT_VALUE); // => 123

define.mutable(obj, 'hiddenVariable', 456);
console.log(obj.hiddenVariable); // => 456

obj.func = function() {
  console.log(this.HIDDEN_CONSTANT_VALUE);
};
obj.func(); // => 123

define.override(obj, function func() {
  func.$uper();
  console.log(this.hiddenVariable);
});
obj.func();
// => 123
//    456
</script>

API

define.immutable(obj, name, value) : void

Defines an read-only and unenumerable property to the specified object.

Parameters:

Parameter	Type	Description
obj	object	The target object.
name	string	The property name.
value	any	The property value.

define.mutable(obj, name, value) : void

Defines an writable and unenumerable property to the specified object.

Parameters:

Parameter	Type	Description
obj	object	The target object.
name	string	The property name.
value	any	The property value.

define.override(obj, name, fn) : void

Redefines a property function of the specified object.

The original function can be accessed by name.$uper.

Parameter	Type	Description
obj	object	The target object.
name	string	The property name.
fn	function	The property function.

define.override(obj, namedFn) : void

Redefines a property function of the specified object with named function.

The original function can be accessed by namedFn.$uper.

Parameter	Type	Description
obj	object	The target object.
namedFn	function	The named function.

Checked

Node.js (11〜)

Platform	11
macOS	◯
Windows10	◯
Linux	◯

Node.js (4〜10)

Platform	4	5	6	7	8	9	10
macOS	◯	◯	◯	◯	◯	◯	◯
Windows10	◯	◯	◯	◯	◯	◯	◯
Linux	◯	◯	◯	◯	◯	◯	◯

io.js (1〜3)

Platform	1	2	3
macOS	◯	◯	◯
Windows10	◯	◯	◯
Linux	◯	◯	◯

Node.js (〜0.12)

Platform	0.8	0.9	0.10	0.11	0.12
macOS	◯	◯	◯	◯	◯
Windows10	◯	◯	◯	◯	◯
Linux	◯	◯	◯	◯	◯

Web browsers

Platform	Chrome	Firefox	Vivaldi	Safari	Edge	IE11
macOS	◯	◯	◯	◯	--	--
Windows10	◯	◯	◯	--	◯	◯
Linux	◯	◯	◯	--	--	--

License

Copyright (C) 2018 Takayuki Sato

This program is free software under MIT License. See the file LICENSE in this distribution for more details.