Skip to content

Commit 5294663

Browse files
Neerajpathak07kgryte
authored andcommitted
remove: remove forOwn from namespace
This commit removes the `forOwn` symbol from the `@stdlib/utils` namespace due to a package migration. BREAKING CHANGE: remove `forOwn` To migrate, users should access the same symbol via the `@stdlib/object` namespace. Ref: stdlib-js#8755
1 parent 34f3fd7 commit 5294663

2 files changed

Lines changed: 0 additions & 49 deletions

File tree

lib/node_modules/@stdlib/utils/docs/types/index.d.ts

Lines changed: 0 additions & 40 deletions
Original file line numberDiff line numberDiff line change
@@ -88,7 +88,6 @@ import flattenArray = require( '@stdlib/utils/flatten-array' );
8888
import flattenObject = require( '@stdlib/utils/flatten-object' );
8989
import forEach = require( '@stdlib/utils/for-each' );
9090
import forEachRight = require( '@stdlib/utils/for-each-right' );
91-
import forOwn = require( '@stdlib/utils/for-own' );
9291
import objectFromEntries = require( '@stdlib/utils/from-entries' );
9392
import functionName = require( '@stdlib/utils/function-name' );
9493
import functionSequence = require( '@stdlib/utils/function-sequence' );
@@ -2189,45 +2188,6 @@ interface Namespace {
21892188
*/
21902189
forEachRight: typeof forEachRight;
21912190

2192-
/**
2193-
* Invokes a function once for each own enumerable property of an object.
2194-
*
2195-
* ## Notes
2196-
*
2197-
* - When invoked, the function is provided three arguments:
2198-
*
2199-
* - `value`: object property value
2200-
* - `key`: object property
2201-
* - `obj`: the input object
2202-
*
2203-
* - To terminate iteration before visiting all properties, the provided function must explicitly return `false`.
2204-
*
2205-
* - The function determines the list of own enumerable properties *before* invoking the provided function. Hence, any modifications made to the input object *after* calling this function (such as adding and removing properties) will *not* affect the list of visited properties.
2206-
*
2207-
* - Iteration order is **not** guaranteed.
2208-
*
2209-
*
2210-
* @param obj - input object
2211-
* @param fcn - function to invoke
2212-
* @param thisArg - execution context
2213-
* @returns obj - input object
2214-
*
2215-
* @example
2216-
* function log( v, key ) {
2217-
* console.log( '%s: %d', key, v );
2218-
* }
2219-
*
2220-
* var obj = {
2221-
* 'a': 1,
2222-
* 'b': 2,
2223-
* 'c': 3,
2224-
* 'd': 4
2225-
* };
2226-
*
2227-
* ns.forOwn( obj, log );
2228-
*/
2229-
forOwn: typeof forOwn;
2230-
22312191
/**
22322192
* Creates an object from an array of key-value pairs.
22332193
*

lib/node_modules/@stdlib/utils/lib/index.js

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -652,15 +652,6 @@ setReadOnly( utils, 'forEach', require( '@stdlib/utils/for-each' ) );
652652
*/
653653
setReadOnly( utils, 'forEachRight', require( '@stdlib/utils/for-each-right' ) );
654654

655-
/**
656-
* @name forOwn
657-
* @memberof utils
658-
* @readonly
659-
* @type {Function}
660-
* @see {@link module:@stdlib/utils/for-own}
661-
*/
662-
setReadOnly( utils, 'forOwn', require( '@stdlib/utils/for-own' ) );
663-
664655
/**
665656
* @name objectFromEntries
666657
* @memberof utils

0 commit comments

Comments
 (0)