@stdlib/assert-is-method
TypeScript icon, indicating that this package has built-in type declarations

0.2.1 • Public • Published
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!

isMethod

NPM version Build Status Coverage Status

Test if an object has a specified method name.

Installation

npm install @stdlib/assert-is-method

Usage

var isMethod = require( '@stdlib/assert-is-method' );

isMethod( value, property )

Returns a boolean indicating if a value has a specified own method name.

function noop() {
    // Example function...
}

var value = {
    'beep': noop
};

var bool = isMethod( value, 'beep' );
// returns true

bool = isMethod( value, 'toString' );
// returns false

Notes

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

    var bool = isMethod( 'beep', 'toString' );
    // returns false
  • Property arguments are coerced to strings.

    function noop() {
        // Example function...
    }
    
    var value = {
        'null': noop
    };
    var bool = isMethod( value, null );
    // returns true
    
    value = {
        '[object Object]': noop
    };
    bool = isMethod( value, {} );
    // returns true
  • The function searches only own properties.

Examples

var isMethod = require( '@stdlib/assert-is-method' );

var bool = isMethod( { 'a': isMethod }, 'a' );
// returns true

bool = isMethod( { 'a': 'b' }, 'a' );
// returns false

bool = isMethod( { 'a': 'b' }, null );
// returns false

bool = isMethod( {}, 'toString' );
// returns false

bool = isMethod( null, 'a' );
// returns false

bool = isMethod( void 0, 'a' );
// returns false

bool = isMethod( { 'null': isMethod }, null );
// returns true

bool = isMethod( { '[object Object]': isMethod }, {} );
// returns true

See Also


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.

Community

Chat


License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.

Package Sidebar

Install

npm i @stdlib/assert-is-method

Homepage

stdlib.io

Weekly Downloads

38

Version

0.2.1

License

Apache-2.0

Unpacked Size

26.9 kB

Total Files

11

Last publish

Collaborators

  • stdlib-bot
  • kgryte
  • planeshifter
  • rreusser