Skip to content

Commit 1b9a036

Browse files
committed
fix: allow correct values for returns option
--- 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: na - task: lint_license_headers status: passed ---
1 parent 5feedbc commit 1b9a036

1 file changed

Lines changed: 7 additions & 7 deletions

File tree

  • lib/node_modules/@stdlib/utils/group-own/docs/types

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

Lines changed: 7 additions & 7 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
/**
@@ -127,7 +127,7 @@ declare function groupOwn<T extends object, K extends string | symbol>(
127127
* @param obj - input object
128128
* @param options - function options
129129
* @param options.thisArg - execution context
130-
* @param options.returns - if `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned (default: 'values')
130+
* @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')
131131
* @param indicator - indicator function indicating which group an element in the input object belongs to
132132
* @returns group results
133133
*
@@ -142,14 +142,14 @@ declare function groupOwn<T extends object, K extends string | symbol>(
142142
* 'd': 'date'
143143
* };
144144
* var opts = {
145-
* 'returns': 'indices'
145+
* 'returns': 'keys'
146146
* };
147147
* var out = groupOwn( obj, opts, indicator );
148148
* // e.g., returns { 'a': [ 'a' ], 'b': [ 'b' ], 'c': [ 'c' ], 'd': [ 'd' ] }
149149
*/
150150
declare function groupOwn<T extends object, K extends string | symbol>(
151151
obj: T,
152-
options: Options & { returns: 'indices' },
152+
options: Options & { returns: 'keys' },
153153
indicator: Indicator<T[keyof T], K>
154154
): { [P in K]: Array<keyof T> };
155155

@@ -174,7 +174,7 @@ declare function groupOwn<T extends object, K extends string | symbol>(
174174
* @param obj - input object
175175
* @param options - function options
176176
* @param options.thisArg - execution context
177-
* @param options.returns - if `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned (default: 'values')
177+
* @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')
178178
* @param indicator - indicator function indicating which group an element in the input object belongs to
179179
* @returns group results
180180
*
@@ -221,7 +221,7 @@ declare function groupOwn<T extends object, K extends string | symbol>(
221221
* @param obj - input object
222222
* @param options - function options
223223
* @param options.thisArg - execution context
224-
* @param options.returns - if `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned (default: 'values')
224+
* @param options.returns - if `'values'`, values are returned; if `'keys'`, keys are returned; if `'*'`, both keys and values are returned (default: 'values')
225225
* @param indicator - indicator function indicating which group an element in the input object belongs to
226226
* @returns group results
227227
*

0 commit comments

Comments
 (0)