changes

Author: JacobWeisenburger

docs/examples.ts

@@ -1,67 +1,35 @@
-import { Result } from '@weis-guys/result'
-
-
-const happy = Result.ok( 'good value' )
-console.log( happy )
-// { success: true, value: "good value" }
-
-
-const sad = Result.err( 'some kind of error' )
-console.log( sad )
-// { success: false, error: "some kind of error" }
-
-
-/**
- * this function could return a value or an error
- */
-function someFn () {
-    return Math.random() > 0.5 ? happy : sad
-}
-
-
-const result = someFn()
-
-Result.match( result )( {
-    ok: value => console.log( value ), // do something with the value
-    err: error => console.error( error ), // do something with the error
-} )
-
-const valueOrError = Result.match( result )( {
-    // optionally perform a typesafe transformation to the value before returning it
-    ok: value => value,
-
-    // optionally perform a typesafe transformation to the error before returning it
-    err: error => error,
-} )
-
-console.log( 'valueOrError:', valueOrError )
-// valueOrError: "good value" | "some kind of error"
-
-type ValueOrError = typeof valueOrError
-// type ValueOrError = "good value" | "some kind of error"
-
-
-const justValue = Result.match( result )( { ok: value => value } )
-console.log( 'justValue:', justValue )
-// justValue: "good value" | undefined
-
-type JustValue = typeof justValue
-// type JustValue = "good value" | undefined
-
-
-const justError = Result.match( result )( { err: error => error } )
-console.log( 'justError:', justError )
-// justError: "some kind of error" | undefined
-
-type JustError = typeof justError
-// type JustError = "some kind of error" | undefined
-
-
-// you can also handle both cases with a normal if/else statement
-if ( result.success ) {
-    console.log( 'result.value:', result.value )
-    // result.value: "good value"
-} else {
-    console.log( 'result.error', result.error )
-    // result.error: "some kind of error"
-}
+// import { Result } from '@weis-guys/result'
+
+// const ok = Result.ok( 'good value' )
+// // { type: 'ok', value: 'good value' }
+
+// const warning = Result.warning( 'some kind of warning' )
+// // { type: 'warning', value: 'some kind of warning' }
+
+// const error = Result.error( 'some kind of error' )
+// // { type: 'error', value: 'some kind of error' }
+
+// /**
+//  * this function could return a value or an error
+//  */
+// function someFn () {
+//     const items = [ ok, warning, error ]
+//     return items[ Math.floor( Math.random() * items.length ) ]
+// }
+
+// const result = someFn()
+
+// switch ( result.type ) {
+//     case 'ok':
+//         console.log( result.value )
+//         // 'good value'
+//         break
+//     case 'warning':
+//         console.warn( result.value )
+//         // 'some kind of warning'
+//         break
+//     case 'error':
+//         console.error( result.value )
+//         // 'some kind of error'
+//         break
+// }