refactor: add neverthrow to range

BREAKING CHANGE

Author: joshunrau

src/__tests__/range.test.ts

@@ -4,10 +4,10 @@ import { range } from '../range.js';
 
 describe('range', () => {
   it('should return an array equal in length to the range', () => {
-    const arr = range(10);
+    const arr = range(10)._unsafeUnwrap();
     expect(arr.length).toBe(10);
   });
-  it('should throw an error if the start is equal to the end', () => {
-    expect(() => range(1, 1)).toThrow();
+  it('should return an error if the start is equal to the end', () => {
+    expect(range(1, 1).isErr()).toBe(true);
   });
 });

src/range.ts

@@ -1,20 +1,25 @@
+import { ok } from 'neverthrow';
+import type { Result } from 'neverthrow';
+
+import { ValueException } from './exception.js';
+
 /** Return an array of integers between 0 (inclusive) and `end` (not inclusive) */
-export function range(end: number): readonly number[];
+export function range(end: number): Result<readonly number[], typeof ValueException.Instance>;
 
 /** Return an array of integers between `start` (inclusive) and `end` (not inclusive) */
-export function range(start: number, end: number): readonly number[];
+export function range(start: number, end: number): Result<readonly number[], typeof ValueException.Instance>;
 
-export function range(...args: number[]): readonly number[] {
+export function range(...args: number[]): Result<readonly number[], typeof ValueException.Instance> {
   const start = args.length === 2 ? args[0]! : 0;
   const end = args.length === 2 ? args[1]! : args[0]!;
 
   if (start >= end) {
-    throw new Error(`End of range '${end}' must be greater than start '${start}'`);
+    return ValueException.asErr(`End of range '${end}' must be greater than start '${start}'`);
   }
 
   const values: number[] = [];
   for (let i = start; i < end; i++) {
     values.push(i);
   }
-  return values;
+  return ok(values);
 }