mirror of
https://github.com/robonen/tools.git
synced 2026-03-20 10:54:44 +00:00
feat(packages/stdlib): add tryIt async util
This commit is contained in:
67
packages/stdlib/src/async/tryIt/index.test.ts
Normal file
67
packages/stdlib/src/async/tryIt/index.test.ts
Normal file
@@ -0,0 +1,67 @@
|
|||||||
|
import { describe, it, expect } from 'vitest';
|
||||||
|
import { tryIt } from '.';
|
||||||
|
|
||||||
|
describe('tryIt', () => {
|
||||||
|
it('handle synchronous functions without errors', () => {
|
||||||
|
const syncFn = (x: number) => x * 2;
|
||||||
|
const wrappedSyncFn = tryIt(syncFn);
|
||||||
|
|
||||||
|
const [error, result] = wrappedSyncFn(2);
|
||||||
|
|
||||||
|
expect(error).toBeUndefined();
|
||||||
|
expect(result).toBe(4);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handle synchronous functions with errors', () => {
|
||||||
|
const syncFn = (): void => { throw new Error('Test error') };
|
||||||
|
const wrappedSyncFn = tryIt(syncFn);
|
||||||
|
|
||||||
|
const [error, result] = wrappedSyncFn();
|
||||||
|
|
||||||
|
expect(error).toBeInstanceOf(Error);
|
||||||
|
expect(error?.message).toBe('Test error');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handle asynchronous functions without errors', async () => {
|
||||||
|
const asyncFn = async (x: number) => x * 2;
|
||||||
|
const wrappedAsyncFn = tryIt(asyncFn);
|
||||||
|
|
||||||
|
const [error, result] = await wrappedAsyncFn(2);
|
||||||
|
|
||||||
|
expect(error).toBeUndefined();
|
||||||
|
expect(result).toBe(4);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handle asynchronous functions with errors', async () => {
|
||||||
|
const asyncFn = async () => { throw new Error('Test error') };
|
||||||
|
const wrappedAsyncFn = tryIt(asyncFn);
|
||||||
|
|
||||||
|
const [error, result] = await wrappedAsyncFn();
|
||||||
|
|
||||||
|
expect(error).toBeInstanceOf(Error);
|
||||||
|
expect(error?.message).toBe('Test error');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handle promise-based functions without errors', async () => {
|
||||||
|
const promiseFn = (x: number) => Promise.resolve(x * 2);
|
||||||
|
const wrappedPromiseFn = tryIt(promiseFn);
|
||||||
|
|
||||||
|
const [error, result] = await wrappedPromiseFn(2);
|
||||||
|
|
||||||
|
expect(error).toBeUndefined();
|
||||||
|
expect(result).toBe(4);
|
||||||
|
});
|
||||||
|
|
||||||
|
it('handle promise-based functions with errors', async () => {
|
||||||
|
const promiseFn = () => Promise.reject(new Error('Test error'));
|
||||||
|
const wrappedPromiseFn = tryIt(promiseFn);
|
||||||
|
|
||||||
|
const [error, result] = await wrappedPromiseFn();
|
||||||
|
|
||||||
|
expect(error).toBeInstanceOf(Error);
|
||||||
|
expect(error?.message).toBe('Test error');
|
||||||
|
expect(result).toBeUndefined();
|
||||||
|
});
|
||||||
|
});
|
||||||
41
packages/stdlib/src/async/tryIt/index.ts
Normal file
41
packages/stdlib/src/async/tryIt/index.ts
Normal file
@@ -0,0 +1,41 @@
|
|||||||
|
import { isPromise } from '../../types';
|
||||||
|
|
||||||
|
export type TryItReturn<Return> = Return extends Promise<any>
|
||||||
|
? Promise<[Error, undefined] | [undefined, Awaited<Return>]>
|
||||||
|
: [Error, undefined] | [undefined, Return];
|
||||||
|
|
||||||
|
/**
|
||||||
|
* @name tryIt
|
||||||
|
* @category Async
|
||||||
|
* @description Wraps promise-based code in a try/catch block without forking the control flow
|
||||||
|
*
|
||||||
|
* @param {Function} fn - The function to try
|
||||||
|
* @returns {Function} - The function that will return a tuple with the error and the result
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const wrappedFetch = tryIt(fetch);
|
||||||
|
* const [error, result] = await wrappedFetch('https://jsonplaceholder.typicode.com/todos/1');
|
||||||
|
*
|
||||||
|
* @example
|
||||||
|
* const [error, result] = await tryIt(fetch)('https://jsonplaceholder.typicode.com/todos/1');
|
||||||
|
*
|
||||||
|
* @since 0.0.3
|
||||||
|
*/
|
||||||
|
export function tryIt<Args extends any[], Return>(
|
||||||
|
fn: (...args: Args) => Return,
|
||||||
|
) {
|
||||||
|
return (...args: Args): TryItReturn<Return> => {
|
||||||
|
try {
|
||||||
|
const result = fn(...args);
|
||||||
|
|
||||||
|
if (isPromise(result))
|
||||||
|
return result
|
||||||
|
.then((value) => [undefined, value])
|
||||||
|
.catch((error) => [error, undefined]) as TryItReturn<Return>;
|
||||||
|
|
||||||
|
return [undefined, result] as TryItReturn<Return>;
|
||||||
|
} catch (error) {
|
||||||
|
return [error, undefined] as TryItReturn<Return>;
|
||||||
|
}
|
||||||
|
};
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user