Nonstop Perpetual Motion

    @fav/prop.list-own-keys

    1.0.3 • Public • Published

    @fav/prop.list-own-keys NPM MIT License Build Status Build Status Coverage status

    Lists enumerable and unenumerable own property keys 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.list-own-keys

    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.list-own-keys/ directory manually.

    Usage

    For Node.js:

    var listOwnKeys = require('@fav/prop.list-own-keys');
    listOwnKeys({ a: 1, b: true, c: 'C' }); // => ['a', 'b', 'c' ]
    
    function Fn() { this.a = 1; }
    Fn.prototype.b = true;
    var fn = new Fn();
    Object.defineProperty(fn, 'c', { value: 'C' });
    listOwnKeys(fn); // => ['a', 'c']

    For Web browsers:

    <script src="fav.prop.list-own-keys.min.js"></script>
    <script>
    var listOwnKeys = fav.prop.listOwnKeys;
    listOwnKeys({ a: 1, b: true, c: 'C' }); // => ['a', 'b', 'c' ]
    </script>

    API

    listOwnKeys(obj) : Array

    List enumerable and unenumerable own property keys of the given object.

    This function returns the same result of Object.getOwnPropertyNames in strict mode except that this function returns an empty array when obj is nullish.

    NOTE: The result of Object.getOwnPropertyNames for a function in strict mode is different between before and after Node.js (io.js) v3. On v3 and later it doesn't contain the properties arguments and callar. This function excludes arguments and caller properties even not in strict mode for same behaviors on all versions of Node.js.

    NOTE: On some browsers, Chrome, Safari, Vivaldi, Edge and IE, the result of Object.getOwnPropertyNames for a function in non-strict mode is different from in strict mode. It contains the properties arguments and caller. This function excludes arguments and caller properties even not in strict mode for same behaviors on other platforms.

    NOTE: The results of Object.getOwnPropertyNames for a function on IE and a no name function on Edge are different from results on other browsers and Node.js. Those do not contain name property. This function appends name property to the result on IE or Edge for same behaviors on target browsers and Node.js

    NOTE: The value of name property of a no-name function is the first assigned variable's name on Node.js v6 or later, and that value is an empty string on the eariler. This function does no treatment about this differeneces.

    NOTE: On some browsers, Chrome, Firefox, Safari, and Vivaldi, the name property of a no-name function is the first assigned variable's name. On Edge, that name property is an empty string. On IE, that name property is undefined. This function does no treatment about this differeneces.

    Parameter:

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

    Return:

    An array of property keys.

    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.

    Install

    npm i @fav/prop.list-own-keys

    DownloadsWeekly Downloads

    9

    Version

    1.0.3

    License

    MIT

    Unpacked Size

    14.6 kB

    Total Files

    7

    Last publish

    Collaborators

    • sttk