main: add types declaration file

[geopic]

Resolves #1. Let me know if there are any issues.

[yumetodo]

In .d.ts file, is it really required to use the jsdoc syntax to specify argument type? I think this is verbose.

[geopic]

I copied index.js and worked from it. If you want I can remove the argument and return type statements from the jsdoc blocks so only the description of each function is left?

[yumetodo]

I think removing is better to keep type file simple. But I want to wait maintener's comment about this.

[wolfram77]

Is there a way to specify type for:

• compare function
• map function

all in one pace and reuse it everywhere?

[wolfram77]

If we remove the @param and @return, it wouldnt show the comments for each parameter. Is there a way to just remove all the jsdoc so that editor directly refers to that in index.js?

I also have made a few mistakes in the jsdoc, and have a few new methods in mind:

• max
• min
• sample
• choose
• shuffle update to use Fisher-Yates algorithm

[yumetodo]

I'm proposing to remove only type information in jsdoc comment. Because there is typescript base type information.

ex.)

  /**
   * Binary searches leftmost value in sorted array.
   * @param x an array (sorted)
   * @param v search value
   * @param fn compare function (a, b)
   * @returns first index of value | ~(index of closest value)
   */
   export function bsearch<T>(x: T[], v: T, fn?: (a: T, b: T) => number): number;

[wolfram77]

That is indeed better than having additional type information. Good suggestion.

[geopic]

@wolfram77 I've made two commits, one with no alteration to the jsdoc blocks and the other which removes the type statements as @yumetodo showed in an example. Let me know if there are any further issues.

[yumetodo]

LGTM!

[wolfram77]

@geopic Indeed type information looks much simpler now. This was indeed a much bigger effort than the other one. I have a few more ideas which i will put together on the todo list. I learnt a bit of typescript declaration from both of you. Thanks.

[wolfram77]

Looks like test function can be merged too.