@stdlib/assert-is-method-in

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!

isMethodIn

Test if an object has a specified method name, either own or inherited.

Installation

npm install @stdlib/assert-is-method-in

Usage

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

isMethodIn( value, property )

Returns a boolean indicating if a value has a specified method name, either own or inherited.

var value = {
    'beep': 'boop'
};

var bool = isMethodIn( value, 'toString' );
// returns true

bool = isMethodIn( value, 'beep' );
// returns false

bool = isMethodIn( value, 'bap' );
// returns false

Notes

• The function does not throw when provided null or undefined. Instead, the function returns false.

  var bool = isMethodIn( null, 'toString' );
  // returns false
  
  bool = isMethodIn( void 0, 'toString' );
  // returns false

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

  var bool = isMethodIn( 'beep', 'toString' );
  // returns true

• Non-symbol property arguments are coerced to strings.

  function noop() {
      // Example function...
  }
  
  var value = {
      'null': noop
  };
  var bool = isMethodIn( value, null );
  // returns true
  
  value = {
      '[object Object]': noop
  };
  bool = isMethodIn( value, {} );
  // returns true

Examples

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

var bool = isMethodIn( {}, 'toString' );
// returns true

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

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

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

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

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

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

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

---

See Also

• @stdlib/assert-has-property: test if an object has a specified property, either own or inherited.
• @stdlib/assert-is-function: test if a value is a function.
• @stdlib/assert-is-method: test if an object has a specified method name.

---

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

---

License

See LICENSE.

Copyright

Copyright © 2016-2024. The Stdlib Authors.