Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/stdlib-js/assert-is-writable-property

Test if an object's own property is writable.
https://github.com/stdlib-js/assert-is-writable-property

assert assertion has is javascript node node-js nodejs obj object own prop property stdlib test util utilities utility utils writable

Last synced: 3 months ago
JSON representation

Test if an object's own property is writable.

Awesome Lists containing this project

README 

        



  

    About stdlib...

  

  
We believe in a future in which the web is a preferred environment for numerical computation. To help realize this future, we've built stdlib. stdlib is a standard library, with an emphasis on numerical and scientific computation, written in JavaScript (and C) for execution in browsers and in Node.js.


  
The library is fully decomposable, being architected in such a way that you can swap out and mix and match APIs and functionality to cater to your exact preferences and use cases.


  
When you use stdlib, you can be absolutely certain that you are using the most thorough, rigorous, well-written, studied, documented, tested, measured, and high-quality code out there.


  
To join us in bringing numerical computing to the web, get started by checking us out on GitHub, and please consider financially supporting stdlib. We greatly appreciate your continued support!



# isWritableProperty



[![NPM version][npm-image]][npm-url] [![Build Status][test-image]][test-url] [![Coverage Status][coverage-image]][coverage-url] 



> Test if an object's own property is writable.



## Installation



```bash

npm install @stdlib/assert-is-writable-property

```



Alternatively,



-   To load the package in a website via a `script` tag without installation and bundlers, use the [ES Module][es-module] available on the [`esm`][esm-url] branch (see [README][esm-readme]).

-   If you are using Deno, visit the [`deno`][deno-url] branch (see [README][deno-readme] for usage intructions).

-   For use in Observable, or in browser/node environments, use the [Universal Module Definition (UMD)][umd] build available on the [`umd`][umd-url] branch (see [README][umd-readme]).



The [branches.md][branches-url] file summarizes the available branches and displays a diagram illustrating their relationships.



To view installation and usage instructions specific to each branch build, be sure to explicitly navigate to the respective README files on each branch, as linked to above.



## Usage



```javascript

var isWritableProperty = require( '@stdlib/assert-is-writable-property' );

```



#### isWritableProperty( value, property )



Returns a `boolean` indicating if a `value` has a writable `property`.



```javascript

var defineProperty = require( '@stdlib/utils-define-property' );



var obj = {

    'foo': 'bar'

};



defineProperty( obj, 'beep', {

    'configurable': false,

    'enumerable': false,

    'writable': false,

    'value': 'boop'

});



defineProperty( obj, 'setter', {

    'configurable': false,

    'enumerable': false,

    'set': function setter( v ) {

        obj.foo = v;

    }

});



var bool = isWritableProperty( obj, 'foo' );

// returns true



bool = isWritableProperty( obj, 'setter' );

// returns true



bool = isWritableProperty( obj, 'beep' );

// returns false

```



## Notes



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



    ```javascript

    var bool = isWritableProperty( 'beep', 'length' );

    // returns false

    ```



-   Property arguments are coerced to `strings`.



    ```javascript

    var obj = {

        'null': 'foo'

    };



    var bool = isWritableProperty( obj, null );

    // returns true

    ```



## Examples



```javascript

var isWritableProperty = require( '@stdlib/assert-is-writable-property' );



var bool = isWritableProperty( [ 'a' ], 'length' );

// returns true



bool = isWritableProperty( { 'a': 'b' }, 'a' );

// returns true



bool = isWritableProperty( [ 'a' ], 0 );

// returns true



bool = isWritableProperty( { 'null': false }, null );

// returns true



bool = isWritableProperty( { '[object Object]': false }, {} );

// returns true



bool = isWritableProperty( {}, 'toString' );

// returns false



bool = isWritableProperty( {}, 'hasOwnProperty' );

// returns false



bool = isWritableProperty( null, 'a' );

// returns false



bool = isWritableProperty( void 0, 'a' );

// returns false

```



* * *



## See Also



-   [`@stdlib/assert-is-readable-property`][@stdlib/assert/is-readable-property]: test if an object's own property is readable.

-   [`@stdlib/assert-is-read-write-property`][@stdlib/assert/is-read-write-property]: test if an object's own property is readable and writable.

-   [`@stdlib/assert-is-writable-property-in`][@stdlib/assert/is-writable-property-in]: test if an object's own or inherited property is writable.

-   [`@stdlib/assert-is-write-only-property`][@stdlib/assert/is-write-only-property]: test if an object's own property is write-only.



* * *



## Notice



This package is part of [stdlib][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][stdlib], see the main project [repository][stdlib].



#### Community



[![Chat][chat-image]][chat-url]



---



## License



See [LICENSE][stdlib-license].



## Copyright



Copyright © 2016-2024. The Stdlib [Authors][stdlib-authors].



[npm-image]: http://img.shields.io/npm/v/@stdlib/assert-is-writable-property.svg

[npm-url]: https://npmjs.org/package/@stdlib/assert-is-writable-property



[test-image]: https://github.com/stdlib-js/assert-is-writable-property/actions/workflows/test.yml/badge.svg?branch=main

[test-url]: https://github.com/stdlib-js/assert-is-writable-property/actions/workflows/test.yml?query=branch:main



[coverage-image]: https://img.shields.io/codecov/c/github/stdlib-js/assert-is-writable-property/main.svg

[coverage-url]: https://codecov.io/github/stdlib-js/assert-is-writable-property?branch=main



[chat-image]: https://img.shields.io/gitter/room/stdlib-js/stdlib.svg

[chat-url]: https://app.gitter.im/#/room/#stdlib-js_stdlib:gitter.im



[stdlib]: https://github.com/stdlib-js/stdlib



[stdlib-authors]: https://github.com/stdlib-js/stdlib/graphs/contributors



[umd]: https://github.com/umdjs/umd

[es-module]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Guide/Modules



[deno-url]: https://github.com/stdlib-js/assert-is-writable-property/tree/deno

[deno-readme]: https://github.com/stdlib-js/assert-is-writable-property/blob/deno/README.md

[umd-url]: https://github.com/stdlib-js/assert-is-writable-property/tree/umd

[umd-readme]: https://github.com/stdlib-js/assert-is-writable-property/blob/umd/README.md

[esm-url]: https://github.com/stdlib-js/assert-is-writable-property/tree/esm

[esm-readme]: https://github.com/stdlib-js/assert-is-writable-property/blob/esm/README.md

[branches-url]: https://github.com/stdlib-js/assert-is-writable-property/blob/main/branches.md



[stdlib-license]: https://raw.githubusercontent.com/stdlib-js/assert-is-writable-property/main/LICENSE



[@stdlib/assert/is-readable-property]: https://github.com/stdlib-js/assert-is-readable-property



[@stdlib/assert/is-read-write-property]: https://github.com/stdlib-js/assert-is-read-write-property



[@stdlib/assert/is-writable-property-in]: https://github.com/stdlib-js/assert-is-writable-property-in



[@stdlib/assert/is-write-only-property]: https://github.com/stdlib-js/assert-is-write-only-property