time-to-botec/squiggle/node_modules/@stdlib/assert/is-method/README.md
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

2.6 KiB

isMethod

Test if an object has a specified method name.

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