adds match functionality, simpler narrowing using ok (deprecating isOk() and isError()), Result.error makes strings constant by default

Author: everweij

docs/chaining-vs-generator-syntax.md

@@ -23,11 +23,11 @@ Similar to arrays and promises, you can also chain operations on a result. The m
 ```ts
 // Without chaining
 const resultA = someOperation();
-if (resultA.isOk()) {
+if (resultA.ok) {
   const resultB = anotherOperation(resultA.value);
-  if (resultB.isOk()) {
+  if (resultB.ok) {
     const resultC = yetAnotherOperation(resultB.value);
-    if (resultC.isOk()) {
+    if (resultC.ok) {
       // do something
     } else {
       // handle error
@@ -44,7 +44,7 @@ const result = someOperation()
   .map((value) => anotherOperation(value))
   .map((value) => yetAnotherOperation(value))
 
-if (result.isOk()) {
+if (result.ok) {
   // do something
 } else {
   // handle error

docs/getting-started.md

@@ -152,11 +152,10 @@ function readConfig(filePath: string) {
 
 const result = readConfig("config.json");
 //     ^?
-
-
-//
 ```
 
+<div class="spacer" />
+
 If you look at the final `result`, you'll see exactly what the outcome of the function can be. And while technically the above code is correct, it is very verbose. Luckily, the library provides a way to make this code more concise.
 
 ### Adding the `Result.try` helper
@@ -194,15 +193,15 @@ function readConfig(filePath: string) {
     () => fs.readFileSync(filePath, "utf-8"),
     (error) => new IOError(`Unable to read file: ${filePath}`, { cause: error })
   );
-  if (contentResult.isError()) {
+  if (!contentResult.ok) {
     return contentResult;
   }
 
   const jsonResult = Result.try(
     () => JSON.parse(contentResult.value),
     () => new ParseError(`Unable to parse JSON from file: ${filePath}`)
   );
-  if (jsonResult.isError()) {
+  if (!jsonResult.ok) {
     return jsonResult;
   }
 
@@ -266,12 +265,12 @@ const parseConfig = Result.wrap(
 
 function readConfig(filePath: string) {
   const contentResult = readFile(filePath);
-  if (contentResult.isError()) {
+  if (!contentResult.ok) {
     return contentResult;
   }
 
   const jsonResult = parseJSON(contentResult.value);
-  if (jsonResult.isError()) {
+  if (!jsonResult.ok) {
     return jsonResult;
   }
 
@@ -360,7 +359,7 @@ Remember this pattern from a few examples back?
 
 ```typescript
 const result = operation();
-if (result.isError()) {
+if (!result.ok) {
   return result;
 }
 ```