[RFC]: Add @stdlib/utils/every-in-by

[kgryte]

Description

This RFC proposes adding a utility to test whether every "own" and inherited property of a provided object satisfies a predicate function.

This is the for-in equivalent of @stdlib/utils/every-by.

Package: @stdlib/utils/every-in-by
Alias: everyInBy

Related Issues

None.

Questions

No.

Other

No.

Checklist

• I have read and understood the Code of Conduct.
• Searched for existing issues and pull requests.
• The issue name begins with RFC:.

[the-r3aper7]

would you explain this more i am not able to understand this?

[kgryte]

By example,

function predicate( value, key, obj ) {
	return ( value > 0 );
}

var o = {
	'a': 1,
	'b': 2,
	'c': 3,
	'd': 4
};

var bool = everyInBy( o, predicate );
// returns true

o.a = -2;
bool = everyInBy( o, predicate );
// returns false

Pay attention to the OP. Namely, it should also work for inherited properties.

[the-r3aper7]

i have created this test function will this work or should i make changes?

function predicate( value, key, obj ) {
	return ( value > 0 );
}

function everyByIn(obj, predicate, thisArg) {
  var out

  if ( !isObject( obj ) ) {
		throw new TypeError( format( 'invalid argument. First argument must be a object. Value: `%s`.', obj ) );
	}
	if ( !isFunction( predicate ) ) {
		throw new TypeError( format( 'invalid argument. Second argument must be a function. Value: `%s`.', predicate ) );
	}

  for (const key in obj) {
    if (obj.hasOwnProperty(key)) {
      out = predicate.call(thisArg, obj[key], key, obj)
      if (!out) {
        return false
      }
    } 
  }
  return true
}

[kgryte]

You don't want the hasOwnProperty check, as this function should also check inherited properties, as mentioned in the OP.

[kgryte]

You can also inline the predicate.call expression into the conditional. No need for a temporary variable in this case.

[kgryte]

Otherwise, yes, what you have proposed is a good start. Feel free to open a PR with the implementation and associated package files.

@Planeshifter Should we go ahead and rename the package to @stdlib/object/every-in-by?

[the-r3aper7]

cool i am excited on this one i will make changes regarding to it. then comment it before making a PR.

[kgryte]

Sounds good! Thanks for working on it!

[the-r3aper7]

no worries happy to contribute.

[the-r3aper7]

here is the updated function.

function everyByIn(obj, predicate, thisArg) {
  
  var key
  
  if (!isObject(obj)) {
    throw new TypeError(format('invalid argument. First argument must be an object. Value: `%s`.', obj));
  }
  if (!isFunction(predicate)) {
    throw new TypeError(format('invalid argument. Second argument must be a function. Value: `%s`.', predicate));
  }

  // Use a for...in loop to iterate through all enumerable properties, including inherited ones
  for (key in obj) {
    if (!predicate.call(thisArg, obj[key], key, obj)) {
      return false;
    }
  }

  return true;
}

[the-r3aper7]

everything is working fine locally.

[kgryte]

That looks reasonable. Note that we author everything in ES5, so no const.

[the-r3aper7]

i have updated the comment code.

[the-r3aper7]

That looks reasonable. Note that we author everything in ES5, so no const.

from next time i will keep that in my mind.

[the-r3aper7]

shall i make a PR now or wait.

[kgryte]

Go ahead and open a PR.

[kgryte]

You'll obviously need to add docs, tests, and benchmarks similar to other packages.

[the-r3aper7]

ok, i will make PR by tonight.