Add Typescript definition

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

@@ -0,0 +1,181 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+// TypeScript Version: 2.0
+
+/**
+* Interface defining function options.
+*/
+interface Options {
+	/**
+	* Execution context.
+	*/
+	thisArg?: any;
+
+	/**
+	* If `'values'`, values are returned; if `'indices'`, indices are returned; if `'*'`, both indices and values are returned.
+	*/
+	returns?: 'values' | 'indices' | '*';
+}
+
+/**
+* Specifies which group a property belongs to.
+*
+* @returns group key
+*/
+type Nullary = () => string | symbol;
+
+/**
+* Specifies which group a property belongs to.
+*
+* @param value - object value
+* @returns group key
+*/
+type Unary = ( value: any ) => string | symbol;
+
+/**
+* Specifies which group a property belongs to.
+*
+* @param value - object value
+* @param key - object key
+* @returns group key
+*/
+type Binary = ( value: any, key: string | symbol ) => string | symbol;
+
+/**
+* Specifies which group a property belongs to.
+*
+* @param value - object value
+* @param key - object key
+* @returns group key
+*/
+type Indicator = Nullary | Unary | Binary;
+
+/**
+* Groups an object's own property values according to an indicator function.
+*
+* ## Notes
+*
+* -   When invoked, the indicator function is provided two arguments:
+*
+*     -   `value`: object value
+*     -   `key`: object key
+*
+* -   The value returned by an indicator function should be a value which can be serialized as an object key.
+*
+* -   If provided an empty object, the function returns an empty object.
+*
+* -   The function iterates over an object's own properties.
+*
+* -   Key iteration order is *not* guaranteed, and, thus, result order is *not* guaranteed.
+*
+* @param obj - input object
+* @param indicator - indicator function indicating which group an element in the input object belongs to
+* @returns group results
+*
+* @example
+* function indicator( v ) {
+*     return v[ 0 ];
+* }
+* var obj = {
+*     'a': 'beep',
+*     'b': 'boop',
+*     'c': 'foo',
+*     'd': 'bar'
+* };
+* var out = groupOwn( obj, indicator );
+* // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }
+*/
+declare function groupOwn( obj: any, indicator: Indicator ): any;
+
+/**
+* Groups an object's own property values according to an indicator function.
+*
+* ## Notes
+*
+* -   When invoked, the indicator function is provided two arguments:
+*
+*     -   `value`: object value
+*     -   `key`: object key
+*
+* -   The value returned by an indicator function should be a value which can be serialized as an object key.
+*
+* -   If provided an empty object, the function returns an empty object.
+*
+* -   The function iterates over an object's own properties.
+*
+* -   Key iteration order is *not* guaranteed, and, thus, result order is *not* guaranteed.
+*
+* @param obj - input object
+* @param options - function options
+* @param options.thisArg - execution context
+* @param options.returns - if `values`, values are returned; if `keys`, keys are returned; if `*`, both keys and values are returned (default: 'values')
+* @param indicator - indicator function indicating which group an element in the input object belongs to
+* @returns group results
+*
+* @example
+* function indicator( v ) {
+*     return v[ 0 ];
+* }
+* var obj = {
+*     'a': 'beep',
+*     'b': 'boop',
+*     'c': 'foo',
+*     'd': 'bar'
+* };
+* var out = groupOwn( obj, indicator );
+* // e.g., returns { 'b': [ 'beep', 'boop', 'bar' ], 'f': [ 'foo' ] }
+*
+* @example
+* function indicator( v ) {
+*     return v[ 0 ];
+* }
+* var obj = {
+*     'a': 'beep',
+*     'b': 'boop',
+*     'c': 'foo',
+*     'd': 'bar'
+* };
+* var opts = {
+*     'returns': 'keys'
+* };
+* var out = groupOwn( obj, opts, indicator );
+* // e.g., returns { 'b': [ 'a', 'b', 'd' ], 'f': [ 'c' ] }
+*
+* @example
+* function indicator( v ) {
+*     return v[ 0 ];
+* }
+* var obj = {
+*     'a': 'beep',
+*     'b': 'boop',
+*     'c': 'foo',
+*     'd': 'bar'
+* };
+* var opts = {
+*     'returns': '*'
+* };
+* var out = groupOwn( obj, opts, indicator );
+* // e.g., returns { 'b': [ [ 'a', 'beep' ], [ 'b', 'boop' ], [ 'd', 'bar' ] ], 'f': [ [ 'c', 'foo' ] ] }
+*/
+declare function groupOwn( obj: any, options: Options, indicator: Indicator ): any; // tslint-disable-line max-line-length
+
+
+// EXPORTS //
+
+export = groupOwn;

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

@@ -0,0 +1,97 @@
+/*
+* @license Apache-2.0
+*
+* Copyright (c) 2019 The Stdlib Authors.
+*
+* Licensed under the Apache License, Version 2.0 (the "License");
+* you may not use this file except in compliance with the License.
+* You may obtain a copy of the License at
+*
+*    http://www.apache.org/licenses/LICENSE-2.0
+*
+* Unless required by applicable law or agreed to in writing, software
+* distributed under the License is distributed on an "AS IS" BASIS,
+* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+* See the License for the specific language governing permissions and
+* limitations under the License.
+*/
+
+import groupOwn = require( './index' );
+
+const indicator = ( v: string ): string => v[ 0 ];
+
+/**
+* A class for instantiating objects with `a` and `b` dummy properties.
+*/
+class Foo {
+	/**
+	* String property.
+	*/
+	a: string;
+
+	/**
+	* String property.
+	*/
+	b: string;
+
+	constructor() {
+		this.a = 'beep';
+		this.b = 'boop';
+	}
+}
+
+
+// TESTS //
+
+// The function returns an object...
+{
+	const obj = new Foo();
+	groupOwn( obj, indicator ); // $ExpectType any
+	groupOwn( {}, indicator ); // $ExpectType any
+	const opts = {
+		'returns': 'indices' as 'indices'
+	};
+	groupOwn( obj, opts, indicator ); // $ExpectType any
+}
+
+// The compiler throws an error if the function is provided a last argument which is not a function...
+{
+	const obj = new Foo();
+	groupOwn( obj, false ); // $ExpectError
+	groupOwn( obj, true ); // $ExpectError
+	groupOwn( obj, 32 ); // $ExpectError
+	groupOwn( obj, 'abc' ); // $ExpectError
+	groupOwn( obj, [] ); // $ExpectError
+	groupOwn( obj, {} ); // $ExpectError
+
+	groupOwn( obj, {}, false ); // $ExpectError
+	groupOwn( obj, {}, true ); // $ExpectError
+	groupOwn( obj, {}, 32 ); // $ExpectError
+	groupOwn( obj, {}, 'abc' ); // $ExpectError
+	groupOwn( obj, {}, [] ); // $ExpectError
+	groupOwn( obj, {}, {} ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an options argument which is not an object...
+{
+	const obj = new Foo();
+	groupOwn( obj, null, indicator ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided a `returns` option which is not one of 'indices', 'values', or '*'...
+{
+	const obj = new Foo();
+	groupOwn( obj, { 'returns': '5' }, indicator ); // $ExpectError
+	groupOwn( obj, { 'returns': 123 }, indicator ); // $ExpectError
+	groupOwn( obj, { 'returns': [] }, indicator ); // $ExpectError
+	groupOwn( obj, { 'returns': {} }, indicator ); // $ExpectError
+	groupOwn( obj, { 'returns': ( x: number ): number => x }, indicator ); // $ExpectError
+}
+
+// The compiler throws an error if the function is provided an invalid number of arguments...
+{
+	const obj = new Foo();
+	groupOwn(); // $ExpectError
+	groupOwn( obj ); // $ExpectError
+	groupOwn( obj, {}, indicator, 16 ); // $ExpectError
+}

lib/node_modules/@stdlib/utils/group-own/package.json

@@ -21,6 +21,7 @@
     "lib": "./lib",
     "test": "./test"
   },
+  "types": "./docs/types",
   "scripts": {},
   "homepage": "https://github.com/stdlib-js/stdlib",
   "repository": {