@tim-code/my-util 0.6.5 → 0.6.6

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@tim-code/my-util",
-  "version": "0.6.5",
+  "version": "0.6.6",
   "description": "",
   "type": "module",
   "author": "Tim Sprowl",

package/src/math.js

@@ -144,6 +144,24 @@ export function range(start, end, increment = 1) {
   return results
 }
 
+/**
+ * Create an array of numbers progressing from start up to and including end.
+ * @param {number} start
+ * @param {number=} end
+ * @param {number=} increment
+ * @returns {number[]}
+ */
+export function between(start, end, increment = 1) {
+  if (!(increment > 0)) {
+    return []
+  }
+  const results = []
+  for (let i = start; i <= end; i += increment) {
+    results.push(i)
+  }
+  return results
+}
+
 /**
  * Check if the argument is a number.
  * This excludes Infinity and NaN, but otherwise is equivalent to `typeof number === "number"`.

package/src/math.test.js

@@ -1,4 +1,5 @@
 import { describe, expect, it } from "@jest/globals"
+import { between } from "./math.js"
 
 // EXPORTED FUNCTIONS UNDER TEST:
 // - mod
@@ -314,6 +315,52 @@ describe("range", () => {
   })
 })
 
+describe("between", () => {
+  it("returns an empty array if start >= end", () => {
+    expect(between(7, 5)).toEqual([])
+    expect(between(10, 5)).toEqual([])
+
+    expect(between(5, 5)).toEqual([5])
+  })
+
+  it("returns a sequence from start to end with default increment 1", () => {
+    expect(between(0, 3)).toEqual([0, 1, 2, 3])
+    expect(between(2, 6)).toEqual([2, 3, 4, 5, 6])
+  })
+
+  it("returns a sequence with a custom positive increment", () => {
+    expect(between(0, 5, 2)).toEqual([0, 2, 4])
+    expect(between(1, 8, 3)).toEqual([1, 4, 7])
+  })
+  it("works with negative start and end", () => {
+    expect(between(-3, 1)).toEqual([-3, -2, -1, 0, 1])
+    expect(between(-5, -2)).toEqual([-5, -4, -3, -2])
+  })
+
+  it("returns an empty array if increment is zero", () => {
+    expect(between(0, 5, 0)).toEqual([])
+  })
+
+  it("returns an empty array if increment is negative and start < end", () => {
+    expect(between(0, 5, -1)).toEqual([])
+    expect(between(2, 6, -2)).toEqual([])
+  })
+
+  it("returns an empty array if increment is negative and start > end", () => {
+    expect(between(5, 0, -1)).toEqual([])
+    expect(between(3, -2, -2)).toEqual([])
+  })
+
+  it("returns an empty array if increment is positive and start > end", () => {
+    expect(between(5, 0, 1)).toEqual([])
+    expect(between(2, -2, 2)).toEqual([])
+  })
+
+  it("handles floating point increments", () => {
+    expect(between(0, 1, 0.25)).toEqual([0, 0.25, 0.5, 0.75, 1])
+  })
+})
+
 describe("isNumber", () => {
   it("returns true for finite numbers", () => {
     expect(isNumber(0)).toBe(true)