Add doc to contructor

seasonedcc · Nov 16, 2023 · 470aa21 · 470aa21
1 parent 9711c33
commit 470aa21
Showing 1 changed file with 5 additions and 0 deletions.
diff --git a/src/composable/composable.ts b/src/composable/composable.ts
@@ -36,6 +36,11 @@ function error(errors: ErrorWithMessage[]): Failure {
   return { success: false, errors }
 }
 
+/**
+ * Creates a composable function.
+ * That function is gonna catch any errors and always return a Result.
+ * @param fn a function to be used as a Composable
+ */
 function composable<T extends Fn>(fn: T): Composable<T> {
   return async (...args) => {
     try {