Skip to content

Commit 376e7a3

Browse files
committed
fix: update TypeScript definitions to use keys instead of indices
--- type: pre_commit_static_analysis_report description: Results of running static analysis checks when committing changes. report: - task: lint_filenames status: passed - task: lint_editorconfig status: passed - task: lint_markdown status: na - task: lint_package_json status: na - task: lint_repl_help status: na - task: lint_javascript_src status: na - task: lint_javascript_cli status: na - task: lint_javascript_examples status: na - task: lint_javascript_tests status: na - task: lint_javascript_benchmarks status: na - task: lint_python status: na - task: lint_r status: na - task: lint_c_src status: na - task: lint_c_examples status: na - task: lint_c_benchmarks status: na - task: lint_c_tests_fixtures status: na - task: lint_shell status: na - task: lint_typescript_declarations status: passed - task: lint_typescript_tests status: passed - task: lint_license_headers status: passed ---
1 parent 7e63571 commit 376e7a3

File tree

7 files changed

+14
-14
lines changed

7 files changed

+14
-14
lines changed

lib/node_modules/@stdlib/object/bifurcate-in/docs/types/index.d.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ interface Options {
2828
thisArg?: any;
2929

3030
/**
31-
* If `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned.
31+
* If `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned.
3232
*/
33-
returns?: 'values' | 'indices' | '*';
33+
returns?: 'values' | 'keys' | '*';
3434
}
3535

3636
/**

lib/node_modules/@stdlib/object/bifurcate-in/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class Foo {
4949
bifurcateIn( obj, predicate ); // $ExpectType any[][]
5050
bifurcateIn( {}, predicate ); // $ExpectType any[][]
5151
const opts = {
52-
'returns': 'indices' as 'indices'
52+
'returns': 'keys' as 'keys'
5353
};
5454
bifurcateIn( obj, opts, predicate ); // $ExpectType any[][]
5555
}
@@ -78,7 +78,7 @@ class Foo {
7878
bifurcateIn( obj, null, predicate ); // $ExpectError
7979
}
8080

81-
// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
81+
// The compiler throws an error if the function is provided a `returns` option which is not one of 'keys', 'values', or '*'...
8282
{
8383
const obj = new Foo();
8484
bifurcateIn( obj, { 'returns': '5' }, predicate ); // $ExpectError

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ interface Options {
2828
thisArg?: any;
2929

3030
/**
31-
* If `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned.
31+
* If `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned.
3232
*/
33-
returns?: 'values' | 'indices' | '*';
33+
returns?: 'values' | 'keys' | '*';
3434
}
3535

3636
/**

lib/node_modules/@stdlib/utils/bifurcate-own/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class Foo {
4949
bifurcateOwn( obj, predicate ); // $ExpectType any[][]
5050
bifurcateOwn( {}, predicate ); // $ExpectType any[][]
5151
const opts = {
52-
'returns': 'indices' as 'indices'
52+
'returns': 'keys' as 'keys'
5353
};
5454
bifurcateOwn( obj, opts, predicate ); // $ExpectType any[][]
5555
}
@@ -78,7 +78,7 @@ class Foo {
7878
bifurcateOwn( obj, null, predicate ); // $ExpectError
7979
}
8080

81-
// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
81+
// The compiler throws an error if the function is provided a `returns` option which is not one of 'keys', 'values', or '*'...
8282
{
8383
const obj = new Foo();
8484
bifurcateOwn( obj, { 'returns': '5' }, predicate ); // $ExpectError

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

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -28,9 +28,9 @@ interface Options {
2828
thisArg?: any;
2929

3030
/**
31-
* If `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned.
31+
* If `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned.
3232
*/
33-
returns?: 'values' | 'indices' | '*';
33+
returns?: 'values' | 'keys' | '*';
3434
}
3535

3636
/**

lib/node_modules/@stdlib/utils/group-in/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class Foo {
4949
groupIn( obj, indicator ); // $ExpectType any
5050
groupIn( {}, indicator ); // $ExpectType any
5151
const opts = {
52-
'returns': 'indices' as 'indices'
52+
'returns': 'keys' as 'keys'
5353
};
5454
groupIn( obj, opts, indicator ); // $ExpectType any
5555
}
@@ -78,7 +78,7 @@ class Foo {
7878
groupIn( obj, null, indicator ); // $ExpectError
7979
}
8080

81-
// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
81+
// The compiler throws an error if the function is provided a `returns` option which is not one of 'keys', 'values', or '*'...
8282
{
8383
const obj = new Foo();
8484
groupIn( obj, { 'returns': '5' }, indicator ); // $ExpectError

lib/node_modules/@stdlib/utils/group-own/docs/types/test.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -49,7 +49,7 @@ class Foo {
4949
groupOwn( obj, indicator ); // $ExpectType { [x: string]: string[]; }
5050
groupOwn( {}, indicator ); // $ExpectType { [x: string]: never[]; }
5151
const opts = {
52-
'returns': 'indices' as const
52+
'returns': 'keys' as const
5353
};
5454
groupOwn( obj, opts, indicator ); // $ExpectType { [x: string]: (keyof Foo)[]; }
5555

@@ -97,7 +97,7 @@ class Foo {
9797
groupOwn( obj, null, indicator ); // $ExpectError
9898
}
9999

100-
// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
100+
// The compiler throws an error if the function is provided a `returns` option which is not one of 'keys', 'values', or '*'...
101101
{
102102
const obj = new Foo();
103103
groupOwn( obj, { 'returns': '5' }, indicator ); // $ExpectError

0 commit comments

Comments
 (0)