Skip to content

Lists enumerable properties of an object and its prototypes.

License

Notifications You must be signed in to change notification settings

sttk/fav-prop.enum-all-props

Repository files navigation

Lists enumerable own and inherited property keys and symbols of an object.

"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.enum-all-props

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.enum-all-props/ directory manually.

Usage

For Node.js:

var enumAllProps = require('@fav/prop.enum-all-props');

var symbol0 = Symbol('foo');
var symbol1 = Symbol('bar');

var obj = { a: 1 };
obj[symbol0] = 2;
Object.defineProperty(obj, 'b', { value: 3 });
Object.defineProperty(obj, symbol1, { value: 4 });

enumAllProps(obj); // => ['a', Symbol(foo) ]

function Fn() { this.a = 1; }
Fn.prototype.b = true;
Fn.prototype[symbol0] = false;
var fn = new Fn();
enumAllProps(fn); // => ['a', 'b', Symbol(foo)]

For Web browsers:

<script src="fav.prop.enum-all-props.min.js"></script>
<script>
var enumAllProps = fav.prop.enumAllProps;

var symbol0 = Symbol('foo');
var symbol1 = Symbol('bar');

var obj = { a: 1 };
obj[symbol0] = 2;
Object.defineProperty(obj, 'b', { value: 3 });
Object.defineProperty(obj, symbol1, { value: 4 });

enumAllProps(obj); // => ['a', Symbol(foo) ]
</script>

API

enumAllProps(obj) : Array

Lists enumerable own and inherited property keys and symbols of the given object.

This function returns same properties enumerated with "for-in", but returns an empty array when obj is nullish.

Parameter:

Parameter Type Description
obj object The object to be listed its property keys and symbols.

Return:

An array of property keys and symbols.

Type: Array

Checked

Node.js (4〜)

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) 2017-2018 Takayuki Sato

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

About

Lists enumerable properties of an object and its prototypes.

Resources

License

Stars

Watchers

Forks

Packages

No packages published