Merge pull request #2 from rathod-sahaab/feat/guess-error-kind-example

Feat/guess error kind example

examples/live/service.ts

@@ -1,4 +1,10 @@
-import { HttpErrorResults, Ok, Result, Err } from '../../src/index'
+import {
+	HttpErrorResults,
+	Ok,
+	Result,
+	Err,
+	IHttpErrorKind,
+} from '../../src/index'
 import { Post } from './contract'
 
 export function serviceCreatePost(
@@ -14,3 +20,19 @@ export function serviceCreatePost(
 
 	return Ok({ article })
 }
+
+export const serviceCreatePostAutoErrorKind = ((article: string) => {
+	// Automatically deduce return error kinds
+	// I don't like it Result is broken up into union components
+	if (article.length < 10) {
+		return Err('BadRequest', 'Article too small')
+	}
+
+	if (article.length > 100) {
+		return HttpErrorResults.InternalServerError('Error storing in DB')
+	}
+
+	const post: Post = { article }
+
+	return Ok(post)
+}) satisfies (article: string) => Result<Post, IHttpErrorKind>

jsr.json

@@ -1,6 +1,6 @@
 {
 	"name": "@rathod-sahaab/http-result",
-	"version": "0.5.2",
+	"version": "0.5.3",
 	"exports": {
 		".": "./src/index.ts"
 		"./ts-rest": "./src/ts-rest/index.ts"

package.json

@@ -18,7 +18,7 @@
 		"error-handling"
 	],
 	"private": false,
-	"version": "0.5.2",
+	"version": "0.5.3",
 	"type": "module",
 	"main": "./dist/http-result.umd.cjs",
 	"module": "./dist/http-result.js",

src/functions.ts

@@ -4,7 +4,7 @@
 
 import { HTTP_ERRORS } from './http.constants'
 import { IHttpErrorKind } from './http.types'
-import { ErrPayload, ErrType, Result, Success } from './types'
+import { ErrPayload, Result, Success } from './types'
 
 /**
  * Helper function to easily create result success type from object
@@ -24,28 +24,29 @@ export function Ok<T>(value: T): Success<T> {
  * return Err('BadRequest', 'Article Too long.')
  * ```
  */
-export function Err<E extends IHttpErrorKind>(
+export function Err<T extends any, E extends IHttpErrorKind>(
 	kind: E,
 	message: string,
-): ErrType<E> {
+): Result<T, E> {
 	return [
 		null,
 		{
 			status: HTTP_ERRORS[kind],
 			kind,
 			messages: [message],
 		},
-	]
+	] as Result<T, E>
 }
 
 const errorFactory = <K extends IHttpErrorKind, A extends IHttpErrorKind>(
 	kind: K,
 ): ((message: string, baseError: ErrPayload<A>) => ErrPayload<K>) => {
-	return (message: string, baseError?: ErrPayload<A>) => ({
-		status: HTTP_ERRORS[kind],
-		kind: kind,
-		messages: baseError ? [...baseError.messages, message] : [message],
-	})
+	return (message: string, baseError?: ErrPayload<A>) =>
+		({
+			status: HTTP_ERRORS[kind],
+			kind: kind,
+			messages: baseError ? [...baseError.messages, message] : [message],
+		}) as ErrPayload<K>
 }
 
 const errorResultFactory = <
@@ -55,10 +56,9 @@ const errorResultFactory = <
 >(
 	errorMaker: (message: string, baseError?: ErrPayload<A>) => ErrPayload<E>,
 ): ((message: string, baseError?: ErrPayload<A>) => Result<T, E>) => {
-	return (message: string, baseError?: ErrPayload<A>) => [
-		null,
-		errorMaker(message, baseError),
-	]
+	return (message: string, baseError?: ErrPayload<A>): Result<T, E> => {
+		return [null, errorMaker(message, baseError)] as Result<T, E>
+	}
 }
 
 type IHttpErrorFnsMap = {