is-extendable

What is is-extendable?

The is-extendable npm package is used to check if a value is extendable, meaning if it can have new properties added to it. This is typically used in the context of extending objects in JavaScript, where certain types of values, like null or undefined, cannot be extended.

What are is-extendable's main functionalities?

Checking if an object is extendable

This feature allows you to check if a given value is an object or function that can have new properties added to it. It returns true for plain objects and functions, and false for non-extendable values like null, undefined, and primitives.

const isExtendable = require('is-extendable');

// Returns true for plain objects
console.log(isExtendable({})); // true

// Returns true for functions
console.log(isExtendable(function() {})); // true

// Returns false for non-extendable values
console.log(isExtendable(null)); // false
console.log(isExtendable(undefined)); // false
console.log(isExtendable(123)); // false

Other packages similar to is-extendable

lodash.isplainobject

This package provides a function to check if a value is a plain object, that is, an object created by the Object constructor or one with a null prototype. It is similar to is-extendable in that it helps determine if an object can be extended, but it specifically checks for plain objects.

is-object

is-object is a package that checks if a value is an object and not null. This is a broader check than is-extendable, which not only checks if the value is an object but also if it is extendable.

extend

The extend package is used to extend an object by copying the properties from additional objects to it. While is-extendable is used to check if an object can be extended, extend actually performs the extension.

README

is-extendable

Returns true if a value is a plain object, array or function.

Install

Install with npm:

$ npm install --save is-extendable

Usage

var isExtendable = require('is-extendable');

Returns true if the value is any of the following:

• array
• plain object
• function

Notes

All objects in JavaScript can have keys, but it's a pain to check for this, since we ether need to verify that the value is not null or undefined and:

• the value is not a primitive, or
• that the object is a plain object, function or array

Also note that an extendable object is not the same as an extensible object, which is one that (in es6) is not sealed, frozen, or marked as non-extensible using preventExtensions.

Release history

v1.0.0 - 2017/07/20

Breaking changes

• No longer considers date, regex or error objects to be extendable

About

Related projects

• assign-deep: Deeply assign the enumerable properties and/or es6 Symbol properies of source objects to the target… more | homepage
• is-equal-shallow: Does a shallow comparison of two objects, returning false if the keys or values differ. | homepage
• is-plain-object: Returns true if an object was created by the Object constructor. | homepage
• isobject: Returns true if the value is an object and not an array or null. | homepage
• kind-of: Get the native type of a value. | homepage

Contributing

Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.

Building docs

(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)

To generate the readme, run the following command:

$ npm install -g verbose/verb#dev verb-generate-readme && verb

Running tests

Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:

$ npm install && npm test

Author

Jon Schlinkert

• github/jonschlinkert
• twitter/jonschlinkert

License

Copyright © 2017, Jon Schlinkert. Released under the MIT License.

This file was generated by verb-generate-readme, v0.6.0, on July 20, 2017.