nano-binary-search 1.0.1 → 1.0.3

package/README.md

@@ -7,6 +7,8 @@ This is a nano binary search implementation. It is a tiny single file with no de
 The only reason I wrote it because I wrote it countless times before, I think it is perfect now
 because it is done right and fits JavaScript — it is ripe for code reuse.
 
+For TypeScript users the typings are included.
+
 ## Why?
 
 Why do I think it is done right? Because it supports important invariants with
@@ -60,7 +62,16 @@ Do you want to search a sub-array? Just pass in indices.
 
 ## API
 
-`binarySearch(sortedArray, lessFn, l = 0, r = sortedArray.length)`:
+The TypeScript-like API is as follows:
+
+```ts
+const index: number = binarySearch<T>(
+  sortedArray: readonly T[],
+  lessFn: (value: T, index: number, array: readonly T[]) => boolean,
+  l: number = 0,
+  r: number = sortedArray.length
+): boolean;
+```
 
 * Inputs:
   * `sortedArray` &mdash; sorted array of some values. We don't care about values in this array.
@@ -69,7 +80,6 @@ Do you want to search a sub-array? Just pass in indices.
     (a value from array) is less than our value, whatever it is. The second value is its index,
     and the third is the `sortedArray`.
     * The function interface is modeled on the callback function of array methods.
-    * The signature: `lessFn(value: T, index: number, array: T[]) => boolean`.
   * `l` &mdash; left index. This index is inclusive. Defaults to 0.
   * `r` &mdash; right index. This index is exclusive. Defaults to `sortedArray.length`.
 
@@ -134,5 +144,7 @@ This project is licensed under the BSD-3-Clause license.
 
 ## Release history
 
-- 1.0.1 *Added TS typings*
-- 1.0.0 *Initial release*
+* 1.0.3 *Added a reference to the TS types*
+* 1.0.2 *Improved docs*
+* 1.0.1 *Added TS typings*
+* 1.0.0 *Initial release*

package/index.d.ts

@@ -1,10 +1,12 @@
 /**
  * Comparison function type. It compares a value with some internal pivot value and returns a boolean.
+ * Additional arguments are `index` (the pivot index) and `sortedArray`.
  */
-type LessFn<T = any> = (x: T, index: number, array: readonly T[]) => boolean;
+type LessFn<T = any> = (value: T, index: number, sortedArray: readonly T[]) => boolean;
 
 /**
- * Binary search.
+ * Binary search (see [docs](https://github.com/uhop/nano-binary-search#readme)):
+ * `binarySearch([1, 2, 3], x => x < 3)`
  *
  * @param sortedArray sorted array. It should be sorted in a compatible way with the comparison function.
  * @param lessFn comparison function that takes a value, compares it with the pivot value, and returns a boolean. See {@link LessFn}.
@@ -15,4 +17,3 @@ type LessFn<T = any> = (x: T, index: number, array: readonly T[]) => boolean;
 export declare function binarySearch<T>(sortedArray: readonly T[], lessFn: LessFn<T>, l?: number, r?: number): number;
 
 export default binarySearch;
-//# sourceMappingURL=index.d.ts.map

package/index.js

@@ -1,3 +1,5 @@
+// @ts-self-types="./index.d.ts"
+
 'use strict';
 
 export const binarySearch = (sortedArray, lessFn, l = 0, r = sortedArray.length) => {

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "nano-binary-search",
   "description": "Binary search for JavaScript done right.",
-  "version": "1.0.1",
+  "version": "1.0.3",
   "type": "module",
   "main": "index.js",
   "types": "index.d.ts",
@@ -45,6 +45,6 @@
   },
   "devDependencies": {
     "tape-six": "^0.9.6",
-    "typescript": "^5.5.4"
+    "typescript": "^5.6.2"
   }
 }