docs(readme): add typescript example (#105)

* typescript readme * update * Update README.md Co-authored-by: Frazer Smith <[email protected]> --------- Co-authored-by: Frazer Smith <[email protected]>
fastify · Jun 2, 2023 · 80f3335 · 80f3335
1 parent b58dbcf
commit 80f3335
Showing 1 changed file with 13 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -37,6 +37,19 @@ const CustomError = createError('ERROR_CODE', 'Hello %s')
 console.log(new CustomError('world')) // error.message => 'Hello world'
 ```
 
+### TypeScript
+
+It is possible to limit your error constructor with a generic type using TypeScript:
+
+```ts
+const CustomError = createError<[string]>('ERROR_CODE', 'Hello %s')
+new CustomError('world')
+//@ts-expect-error
+new CustomError(1)
+//@ts-expect-error
+new CustomError(1)
+```
+
 ## License
 
 Licensed under [MIT](./LICENSE).