Skip to content

Commit 20ee8cb

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

2 files changed

Lines changed: 0 additions & 83 deletions

File tree

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

Lines changed: 0 additions & 74 deletions
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,6 @@ import argumentFunction = require( '@stdlib/utils/argument-function' );
2828
import async = require( '@stdlib/utils/async' );
2929
import bifurcate = require( '@stdlib/utils/bifurcate' );
3030
import bifurcateBy = require( '@stdlib/utils/bifurcate-by' );
31-
import bifurcateIn = require( '@stdlib/utils/bifurcate-in' );
3231
import bifurcateOwn = require( '@stdlib/utils/bifurcate-own' );
3332
import compose = require( '@stdlib/utils/compose' );
3433
import constantFunction = require( '@stdlib/utils/constant-function' );
@@ -437,79 +436,6 @@ interface Namespace {
437436
*/
438437
bifurcateBy: typeof bifurcateBy;
439438

440-
/**
441-
* Splits an object's own and inherited property values into two groups according to a predicate function.
442-
*
443-
* ## Notes
444-
*
445-
* - When invoked, the predicate function is provided two arguments:
446-
*
447-
* - `value`: object value
448-
* - `key`: object key
449-
*
450-
* - If a predicate function returns a truthy value, a value is placed in the first group; otherwise, a value is placed in the second group.
451-
*
452-
* - If provided an empty object with no prototype, the function returns an empty array.
453-
*
454-
* - The function iterates over an object's own and inherited properties.
455-
*
456-
* - Key iteration order is *not* guaranteed, and, thus, result order is *not* guaranteed.
457-
*
458-
* @param obj - input object
459-
* @param options - function options
460-
* @param options.thisArg - execution context
461-
* @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')
462-
* @param predicate - predicate function indicating which group an element in the input object belongs to
463-
* @returns group results
464-
*
465-
* @example
466-
* function predicate( v ) {
467-
* return v[ 0 ] === 'b';
468-
* }
469-
*
470-
* function Foo() {
471-
* this.a = 'beep';
472-
* this.b = 'boop';
473-
* return this;
474-
* }
475-
*
476-
* Foo.prototype = Object.create( null );
477-
* Foo.prototype.c = 'foo';
478-
* Foo.prototype.d = 'bar';
479-
*
480-
* var obj = new Foo();
481-
*
482-
* var opts = {
483-
* 'returns': 'keys'
484-
* };
485-
* var out = ns.bifurcateIn( obj, opts, predicate );
486-
* // e.g., returns [ [ 'a', 'b', 'd' ], [ 'c' ] ]
487-
*
488-
* @example
489-
* function predicate( v ) {
490-
* return v[ 0 ] === 'b';
491-
* }
492-
*
493-
* function Foo() {
494-
* this.a = 'beep';
495-
* this.b = 'boop';
496-
* return this;
497-
* }
498-
*
499-
* Foo.prototype = Object.create( null );
500-
* Foo.prototype.c = 'foo';
501-
* Foo.prototype.d = 'bar';
502-
*
503-
* var obj = new Foo();
504-
*
505-
* var opts = {
506-
* 'returns': '*'
507-
* };
508-
* var out = ns.bifurcateIn( obj, opts, predicate );
509-
* // e.g., returns [ [ [ 'a', 'beep' ], [ 'b', 'boop' ], [ 'd', 'bar' ] ], [ [ 'c', 'foo' ] ] ]
510-
*/
511-
bifurcateIn: typeof bifurcateIn;
512-
513439
/**
514440
* Splits an object's own property values into two groups according to a predicate function.
515441
*

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

Lines changed: 0 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -112,15 +112,6 @@ setReadOnly( utils, 'bifurcate', require( '@stdlib/utils/bifurcate' ) );
112112
*/
113113
setReadOnly( utils, 'bifurcateBy', require( '@stdlib/utils/bifurcate-by' ) );
114114

115-
/**
116-
* @name bifurcateIn
117-
* @memberof utils
118-
* @readonly
119-
* @type {Function}
120-
* @see {@link module:@stdlib/utils/bifurcate-in}
121-
*/
122-
setReadOnly( utils, 'bifurcateIn', require( '@stdlib/utils/bifurcate-in' ) );
123-
124115
/**
125116
* @name bifurcateOwn
126117
* @memberof utils

0 commit comments

Comments
 (0)