Improve error naming

wiktor-obrebski · Jul 29, 2022 · c7c6a5b · c7c6a5b
1 parent ce8194c
commit c7c6a5b
Show file tree

Hide file tree

Showing 12 changed files with 68 additions and 44 deletions.
diff --git a/docs/REFERENCE.md b/docs/REFERENCE.md
@@ -112,7 +112,7 @@ Err.of<TError>(value: TError): Err<TError>
 ```typescript
 import { Err } from 'type-safe-errors';
 
-class UserNotFound extends Error {
+class UserNotFoundError extends Error {
   name = "UserNotFound" as const;
 }
 
@@ -243,7 +243,7 @@ Err<TErr>.map<unknown>(callback: (value: never) => never): Err<TErr>;
 ```typescript
 import { Ok, Err } from 'type-safe-errors';
 
-class UserNotFound extends Error {
+class UserNotFoundError extends Error {
   name = "UserNotFound" as const;
 }
 

diff --git a/examples/basic-example/pay.ts b/examples/basic-example/pay.ts
@@ -1,16 +1,16 @@
 import { Err, Ok } from 'type-safe-errors';
-import { Product, UserCard, MissingPrice, InvalidCVC } from './types';
+import { Product, UserCard, MissingPriceError, InvalidCVCError } from './types';
 
 export async function payForProduct(card: UserCard, product: Product) {
   // simulate fetching data
   await sleep(10);
 
   if (!card.cvc) {
-    return Err.of(new InvalidCVC());
+    return Err.of(new InvalidCVCError());
   }
 
   if (product.price === null) {
-    return Err.of(new MissingPrice());
+    return Err.of(new MissingPriceError());
   }
 
   // payment logic

diff --git a/examples/basic-example/types.ts b/examples/basic-example/types.ts
@@ -1,4 +1,4 @@
-export { UserCard, MissingPrice, InvalidCVC, Product };
+export { UserCard, MissingPriceError, InvalidCVCError, Product };
 
 interface UserCard {
   number: string;
@@ -9,10 +9,10 @@ interface Product {
   price: number | null;
 }
 
-class InvalidCVC extends Error {
+class InvalidCVCError extends Error {
   name = 'InvalidCVC' as const;
 }
 
-class MissingPrice extends Error {
+class MissingPriceError extends Error {
   name = 'MissingPrice' as const;
 }
diff --git a/examples/express/errors.ts b/examples/express/errors.ts
@@ -1,13 +1,13 @@
-export { InvalidCVC, UknownProduct, MissingCardNumber };
+export { InvalidCVCError, UknownProductError, MissingCardNumberError };
 
-class InvalidCVC extends Error {
+class InvalidCVCError extends Error {
   name = 'InvalidCVC' as const;
 }
 
-class UknownProduct extends Error {
+class UknownProductError extends Error {
   name = 'UknownProduct' as const;
 }
 
-class MissingCardNumber extends Error {
+class MissingCardNumberError extends Error {
   name = 'MissingCardNumber' as const;
 }
diff --git a/examples/express/index.ts b/examples/express/index.ts
@@ -3,7 +3,11 @@ import morgan from 'morgan';
 import { Result } from 'type-safe-errors';
 
 import { getProductPrice, payForProduct } from './pay';
-import { InvalidCVC, UknownProduct, MissingCardNumber } from './errors';
+import {
+  InvalidCVCError,
+  UknownProductError,
+  MissingCardNumberError,
+} from './errors';
 
 interface PaymentRequestBody {
   cardNumber: string;
@@ -24,13 +28,13 @@ app.post<{ Body: PaymentRequestBody }>('/payments', async (req, res) => {
     .map((successResult) => {
       res.status(200).send({ message: successResult });
     })
-    .mapErr(InvalidCVC, () => {
+    .mapErr(InvalidCVCError, () => {
       res.status(422).send({ message: 'Invalid card CVC' });
     })
-    .mapErr(UknownProduct, () => {
+    .mapErr(UknownProductError, () => {
       res.status(404).send({ message: `Product '${productId}' not found` });
     })
-    .mapErr(MissingCardNumber, () => {
+    .mapErr(MissingCardNumberError, () => {
       res.status(400).send({ message: `Invalid card number: '${cardNumber}'` });
     })
     .promise();

diff --git a/examples/express/pay.ts b/examples/express/pay.ts
@@ -1,5 +1,9 @@
-import { InvalidCVC, MissingCardNumber, UknownProduct } from './errors';
 import { Err, Ok } from 'type-safe-errors';
+import {
+  InvalidCVCError,
+  MissingCardNumberError,
+  UknownProductError,
+} from './errors';
 
 const supportedProductId = '123';
 const supportedCVC = '456';
@@ -15,11 +19,11 @@ async function payForProduct(
   await sleep(10);
 
   if (cvc !== supportedCVC) {
-    return Err.of(new InvalidCVC());
+    return Err.of(new InvalidCVCError());
   }
 
   if (!cardNumber) {
-    return Err.of(new MissingCardNumber());
+    return Err.of(new MissingCardNumberError());
   }
 
   return Ok.of(`Success. Payed ${productPrice}`);
@@ -31,7 +35,7 @@ async function getProductPrice(productId: string) {
 
   return productId === supportedProductId
     ? Ok.of(12.5)
-    : Err.of(new UknownProduct());
+    : Err.of(new UknownProductError());
 }
 
 function sleep(sleepMs: number) {

diff --git a/examples/fastify/errors.ts b/examples/fastify/errors.ts
@@ -1,13 +1,13 @@
-export { InvalidCVC, UknownProduct, MissingCardNumber };
+export { InvalidCVCError, UknownProductError, MissingCardNumberError };
 
-class InvalidCVC extends Error {
+class InvalidCVCError extends Error {
   name = 'InvalidCVC' as const;
 }
 
-class UknownProduct extends Error {
+class UknownProductError extends Error {
   name = 'UknownProduct' as const;
 }
 
-class MissingCardNumber extends Error {
+class MissingCardNumberError extends Error {
   name = 'MissingCardNumber' as const;
 }
diff --git a/examples/fastify/index.ts b/examples/fastify/index.ts
@@ -2,7 +2,11 @@ import { fastify } from 'fastify';
 import { Result } from 'type-safe-errors';
 
 import { getProductPrice, payForProduct } from './pay';
-import { InvalidCVC, UknownProduct, MissingCardNumber } from './errors';
+import {
+  InvalidCVCError,
+  UknownProductError,
+  MissingCardNumberError,
+} from './errors';
 
 interface PaymentRequestBody {
   cardNumber: string;
@@ -20,13 +24,13 @@ app.post<{ Body: PaymentRequestBody }>('/payments', async (req, reply) => {
     .map((successResult) => {
       reply.status(200).send({ message: successResult });
     })
-    .mapErr(InvalidCVC, () => {
+    .mapErr(InvalidCVCError, () => {
       reply.status(422).send({ message: 'Invalid card CVC' });
     })
-    .mapErr(UknownProduct, () => {
+    .mapErr(UknownProductError, () => {
       reply.status(404).send({ message: `Product '${productId}' not found` });
     })
-    .mapErr(MissingCardNumber, () => {
+    .mapErr(MissingCardNumberError, () => {
       reply
         .status(400)
         .send({ message: `Invalid card number: '${cardNumber}'` });

diff --git a/examples/fastify/pay.ts b/examples/fastify/pay.ts
@@ -1,5 +1,9 @@
-import { InvalidCVC, MissingCardNumber, UknownProduct } from './errors';
 import { Err, Ok } from 'type-safe-errors';
+import {
+  InvalidCVCError,
+  MissingCardNumberError,
+  UknownProductError,
+} from './errors';
 
 const supportedProductId = '123';
 const supportedCVC = '456';
@@ -15,11 +19,11 @@ async function payForProduct(
   await sleep(10);
 
   if (cvc !== supportedCVC) {
-    return Err.of(new InvalidCVC());
+    return Err.of(new InvalidCVCError());
   }
 
   if (!cardNumber) {
-    return Err.of(new MissingCardNumber());
+    return Err.of(new MissingCardNumberError());
   }
 
   return Ok.of(`Success. Payed ${productPrice}`);
@@ -31,7 +35,7 @@ async function getProductPrice(productId: string) {
 
   return productId === supportedProductId
     ? Ok.of(12.5)
-    : Err.of(new UknownProduct());
+    : Err.of(new UknownProductError());
 }
 
 function sleep(sleepMs: number) {

diff --git a/examples/nestjs/pay/errors.ts b/examples/nestjs/pay/errors.ts
@@ -1,13 +1,13 @@
-export { InvalidCVC, UknownProduct, MissingCardNumber };
+export { InvalidCVCError, UknownProductError, MissingCardNumberError };
 
-class InvalidCVC extends Error {
+class InvalidCVCError extends Error {
   name = 'InvalidCVC' as const;
 }
 
-class UknownProduct extends Error {
+class UknownProductError extends Error {
   name = 'UknownProduct' as const;
 }
 
-class MissingCardNumber extends Error {
+class MissingCardNumberError extends Error {
   name = 'MissingCardNumber' as const;
 }
diff --git a/examples/nestjs/pay/pay.controller.ts b/examples/nestjs/pay/pay.controller.ts
@@ -2,7 +2,11 @@ import { Controller, Post, Body, Res } from '@nestjs/common';
 import { Response } from 'express';
 import { Result } from 'type-safe-errors';
 
-import { InvalidCVC, UknownProduct, MissingCardNumber } from './errors';
+import {
+  InvalidCVCError,
+  UknownProductError,
+  MissingCardNumberError,
+} from './errors';
 import { PayService } from './pay.service';
 
 class PaymentDto {
@@ -24,13 +28,13 @@ export class PayController {
       .map((successResult) => {
         res.status(200).send({ message: successResult });
       })
-      .mapErr(InvalidCVC, () => {
+      .mapErr(InvalidCVCError, () => {
         res.status(422).send({ message: 'Invalid card CVC' });
       })
-      .mapErr(UknownProduct, () => {
+      .mapErr(UknownProductError, () => {
         res.status(404).send({ message: `Product '${productId}' not found` });
       })
-      .mapErr(MissingCardNumber, () => {
+      .mapErr(MissingCardNumberError, () => {
         res
           .status(400)
           .send({ message: `Invalid card number: '${cardNumber}'` });

diff --git a/examples/nestjs/pay/pay.service.ts b/examples/nestjs/pay/pay.service.ts
@@ -1,6 +1,10 @@
 import { Injectable } from '@nestjs/common';
-import { InvalidCVC, UknownProduct, MissingCardNumber } from './errors';
 import { Err, Ok } from 'type-safe-errors';
+import {
+  InvalidCVCError,
+  UknownProductError,
+  MissingCardNumberError,
+} from './errors';
 
 const supportedProductId = '123';
 const supportedCVC = '456';
@@ -12,11 +16,11 @@ export class PayService {
     await sleep(10);
 
     if (cvc !== supportedCVC) {
-      return Err.of(new InvalidCVC());
+      return Err.of(new InvalidCVCError());
     }
 
     if (!cardNumber) {
-      return Err.of(new MissingCardNumber());
+      return Err.of(new MissingCardNumberError());
     }
 
     return Ok.of(`Success. Payed ${productPrice}`);
@@ -28,7 +32,7 @@ export class PayService {
 
     return productId === supportedProductId
       ? Ok.of(12.5)
-      : Err.of(new UknownProduct());
+      : Err.of(new UknownProductError());
   }
 }