@stdlib/utils-get-prototype-of

What is @stdlib/utils-get-prototype-of?

@stdlib/utils-get-prototype-of is a utility package that provides a function to get the prototype of an object. This can be useful in various scenarios such as inheritance checks, debugging, and understanding object structures.

What are @stdlib/utils-get-prototype-of's main functionalities?

Get Prototype of an Object

This feature allows you to retrieve the prototype of a given object. In this example, the prototype of an empty object is retrieved and logged to the console.

const getPrototypeOf = require('@stdlib/utils-get-prototype-of');
const obj = {};
const proto = getPrototypeOf(obj);
console.log(proto);

Check Inheritance

This feature can be used to check if an object inherits from a specific prototype. In this example, we create a parent and child constructor, set up inheritance, and then check if an instance of the child inherits from the parent's prototype.

const getPrototypeOf = require('@stdlib/utils-get-prototype-of');
function Parent() {}
function Child() {}
Child.prototype = Object.create(Parent.prototype);
const childInstance = new Child();
const isInherited = getPrototypeOf(childInstance) === Parent.prototype;
console.log(isInherited);

Other packages similar to @stdlib/utils-get-prototype-of

lodash

Lodash is a popular utility library that includes a wide range of functions, including '_.prototypeOf' which can be used to get the prototype of an object. While Lodash offers more comprehensive utilities, it is larger in size compared to @stdlib/utils-get-prototype-of.

core-js

Core-js is a modular standard library for JavaScript that includes polyfills for ECMAScript features. It provides a 'core-js/library/fn/object/get-prototype-of' function that can be used to get the prototype of an object. It is more feature-rich and includes polyfills for other ECMAScript features.

README

getPrototypeOf

Return the prototype of a provided object.

Installation

npm install @stdlib/utils-get-prototype-of

Usage

var getPrototypeOf = require( '@stdlib/utils-get-prototype-of' );

getPrototypeOf( value )

Returns the prototype of an input value.

var proto = getPrototypeOf( {} );
// returns {}

Notes

• In contrast to the native Object.getPrototypeOf, this function does not throw when provided null or undefined. Instead, similar to when provided any value with no inherited properties, the function returns null.

  var proto = getPrototypeOf( Object.create( null ) );
  // returns null
  
  proto = getPrototypeOf( null );
  // returns null
  
  proto = getPrototypeOf( void 0 );
  // returns null
  

• Value arguments other than null or undefined are coerced to objects.

  var proto = getPrototypeOf( 'beep' );
  // returns String.prototype
  
  proto = getPrototypeOf( 5 );
  // returns Number.prototype
  

  This behavior matches ES6/ES2015 native Object.getPrototypeOf behavior. In ES5, the native Object.getPrototypeOf throws when provided non-object values.

Examples

var getPrototypeOf = require( '@stdlib/utils-get-prototype-of' );

var proto = getPrototypeOf( 'beep' );
// returns String.prototype

proto = getPrototypeOf( 5 );
// returns Number.prototype

proto = getPrototypeOf( true );
// returns Boolean.prototype

proto = getPrototypeOf( null );
// returns null

proto = getPrototypeOf( void 0 );
// returns null

proto = getPrototypeOf( [] );
// returns Array.prototype

proto = getPrototypeOf( {} );
// returns {}

proto = getPrototypeOf( function foo() {} );
// returns Function.prototype

---

Notice

This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.

For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.

---

License

See LICENSE.

Copyright

Copyright © 2016-2021. The Stdlib Authors.

Changelog

0.0.3 (2021-06-16)

No changes reported for this release.

</section> <!-- /.release --> <section class="release" id="v0.0.2">