Typos and Rewriting (#77)

Author: arthurfiorette

README.md

@@ -13,14 +13,16 @@
 
 <br />
 
-This proposal aims to address the ergonomic challenges of managing multiple, often nested, `try/catch` blocks that are necessary for handling operations that may fail at various points.
+This proposal addresses the ergonomic challenges of managing multiple, often nested, `try/catch` blocks necessary for handling operations that may fail at various points.
 
 Only the `catch (error) {}` block represents actual control flow, while no program state inherently depends on being inside a `try {}` block. Therefore, forcing the successful flow into nested blocks is not ideal.
 
 <hr />
 <br />
 
 - [Try/Catch Is Not Enough](#trycatch-is-not-enough)
+- [Status](#status)
+- [Authors](#authors)
 - [Caller's Approach](#callers-approach)
 - [What This Proposal Does Not Aim to Solve](#what-this-proposal-does-not-aim-to-solve)
   - [Type-Safe Errors](#type-safe-errors)
@@ -42,7 +44,6 @@ Only the `catch (error) {}` block represents actual control flow, while no progr
 - [The Need for an `ok` Value](#the-need-for-an-ok-value)
 - [Why a Proposal?](#why-a-proposal)
 - [Help Us Improve This Proposal](#help-us-improve-this-proposal)
-- [Authors](#authors)
 - [Inspiration](#inspiration)
 - [License](#license)
 
@@ -125,7 +126,23 @@ async function handle(request, reply) {
 }
 ```
 
-A `try` statement provide significant flexibility and arguably result in more readable code. A `try` statement is a statement that can be used wherever a statement is expected, allowing for concise and readable error handling.
+A `try` statement provides significant flexibility and arguably results in more readable code. A `try` statement is a statement that can be used wherever a statement is expected, allowing for concise and readable error handling.
+
+<br />
+
+## Status
+
+**Stage:** 0 \
+**Champion:** _Actively looking for one_
+
+_For more information see the [TC39 proposal process](https://tc39.es/process-document/)._
+
+<br />
+
+## Authors
+
+- [Arthur Fiorette](https://github.com/arthurfiorette) <sub>([X](https://x.com/arthurfiorette))</sub>
+- [Arlen Beiler](https://github.com/Arlen22)
 
 <br />
 
@@ -139,7 +156,7 @@ With that in mind, improvements in error handling can be approached in two ways:
 
    ```js
    try {
-     const result = work()
+     const value = work()
    } catch (error) {
      console.error(error)
    }
@@ -149,12 +166,12 @@ With that in mind, improvements in error handling can be approached in two ways:
 
    ```js
    function work() {
-     // Performs some operation
+     try {
+       // Performs some operation
 
-     if (error) {
-       return { status: "error", error }
-     } else {
-       return { status: "ok", data }
+       return { ok: true, value }
+     } catch (error) {
+       return { ok: false, error }
      }
    }
    ```
@@ -173,11 +190,11 @@ Ironically, these are precisely the kinds of functions where improved error hand
 
 ### Type-Safe Errors
 
-The `throw` statement in JavaScript can throw any type of value. This proposal does not impose nor proposes any kind safety around error handling.
+The `throw` statement in JavaScript can throw any type of value. This proposal does not impose nor propose any kind of safety around error handling.
 
 - No generic error type for the proposed [Result](#result-class) class will be added.
 - No catch branching based on error type will be added. See [GitHub Issue #43](https://github.com/arthurfiorette/proposal-try-operator/issues/43) for more information.
-- No ways to annotate a callable to specify the error type it throws will be added.
+- No way to annotate a callable to specify the error type it throws will be added.
 
 For more information, also see [microsoft/typescript#13219](https://github.com/Microsoft/TypeScript/issues/13219). _()_
 
@@ -232,7 +249,7 @@ const result = _result
 
 ### Can be inlined.
 
-Similar to `void`, `typeof`, `yield` and `new`:
+Similar to `void`, `typeof`, `yield`, and `new`:
 
 ```js
 array.map((fn) => try fn()).filter((result) => result.ok) // works :)
@@ -334,7 +351,7 @@ A detailed discussion about this topic is available at [GitHub Issue #55](https:
 
 ### Void Operations
 
-In scenarios where the successful result of a operation is not needed, it can be safely ignored:
+In scenarios where the successful result of an operation is not needed, it can be safely ignored:
 
 ```js
 function work() {
@@ -369,7 +386,7 @@ The `Result` class represents the form of the value returned by the `try` operat
 
 A `Result` instance contains three properties:
 
-- **`ok`**: A boolean indicating whether the expression executed successfully.
+- **`ok`**: A boolean indicating whether the expression was executed successfully.
 - **`error`**: The error thrown during execution, or `undefined` if no error occurred.
 - **`value`**: The data returned from the execution, or `undefined` if an error occurred.
 
@@ -500,13 +517,6 @@ This proposal is in its early stages, and we welcome your input to help refine i
 
 <br />
 
-## Authors
-
-- [Arthur Fiorette](https://github.com/arthurfiorette) <sub>([X](https://x.com/arthurfiorette))</sub>
-- [Arlen Beiler](https://github.com/Arlen22)
-
-<br />
-
 ## Inspiration
 
 - [This tweet from @LeaVerou](https://x.com/LeaVerou/status/1819381809773216099)

package.json

@@ -1,16 +1,16 @@
 {
   "private": true,
-  "name": "proposal-try-statements",
+  "name": "proposal-try-operator",
   "description": "A repository template for ECMAScript proposals.",
   "scripts": {
     "start": "npm run build-loose -- --watch",
     "build": "npm run build-loose -- --strict",
     "build-loose": "node -e 'fs.mkdirSync(\"build\", { recursive: true })' && ecmarkup --load-biblio @tc39/ecma262-biblio --verbose spec.emu build/index.html --lint-spec"
   },
-  "homepage": "https://github.com/arthurfiorette/proposal-try-statements#readme",
+  "homepage": "https://github.com/arthurfiorette/proposal-try-operator#readme",
   "repository": {
     "type": "git",
-    "url": "git+https://github.com/arthurfiorette/proposal-try-statements.git"
+    "url": "git+https://github.com/arthurfiorette/proposal-try-operator.git"
   },
   "license": "MIT",
   "devDependencies": {
@@ -19,5 +19,6 @@
   },
   "engines": {
     "node": ">= 12"
-  }
+  },
+  "version": ""
 }

spec.emu

@@ -39,36 +39,36 @@ contributors: Arthur Fiorette, Arlen Beiler
     <h1>
       TryExpressionResult (
         _result_: a Completion Record,
-      ): either a normal completion containing a TryResult or an abrupt completion
+      ): either a normal completion containing a Result or an abrupt completion
     </h1>
     <dl class="header">
     </dl>
     <emu-alg>
-      1. If _result_ is a normal completion, return TryResult.ok(_result_.[[VALUE]]).
-      1. If _result_ is a throw completion, return TryResult.error(_result_.[[VALUE]]).
+      1. If _result_ is a normal completion, return Result.ok(_result_.[[VALUE]]).
+      1. If _result_ is a throw completion, return Result.error(_result_.[[VALUE]]).
       1. Return ? _result_.
     </emu-alg>
   </emu-clause>
   <emu-clause id="sec-try-expression-result-ok" type="abstract operation">
     <h1>
-      TryResult.ok (
+      Result.ok (
         _value_: an ECMAScript language value,
-      ): a TryResult
+      ): a Result
     </h1>
     <dl class="header">
       <dt>description</dt>
-      <dd>It is the abstract equivelant of calling `TryResult.ok(value)`</dd>
+      <dd>It is the abstract equivelant of calling `Result.ok(value)`</dd>
     </dl>
   </emu-clause>
   <emu-clause id="sec-try-expression-result-error" type="abstract operation">
     <h1>
-      TryResult.error (
+      Result.error (
         _value_: an ECMAScript language value,
-      ): a TryResult
+      ): a Result
     </h1>
     <dl class="header">
       <dt>description</dt>
-      <dd>It is the abstract equivelant of calling `TryResult.error(value)`</dd>
+      <dd>It is the abstract equivelant of calling `Result.error(value)`</dd>
     </dl>
   </emu-clause>
 </emu-clause>
@@ -92,28 +92,28 @@ contributors: Arthur Fiorette, Arlen Beiler
       </thead>
       <tr>
         <td>
-          %TryResult%
+          %Result%
         </td>
         <td>
-          `TryResult`
+          `Result`
         </td>
         <td>
-          The `TryResult` constructor (<emu-xref href="#sec-try-result-constructor"></emu-xref>)
+          The `Result` constructor (<emu-xref href="#sec-result-constructor"></emu-xref>)
         </td>
       </tr>
     </table>
   </emu-table>
 </emu-clause>
 
-<emu-clause id="sec-try-result-constructor">
-  <h1>The TryResult Constructor</h1>
-  <p>The TryResult constructor:</p>
+<emu-clause id="sec-result-constructor">
+  <h1>The Result Constructor</h1>
+  <p>The Result constructor:</p>
   <ul>
-    <li>is <dfn variants="TryResult">%TryResult%</dfn>.</li>
-    <li>is the initial value of the *"TryResult"* property of the global object.</li>
+    <li>is <dfn variants="Result">%Result%</dfn>.</li>
+    <li>is the initial value of the *"Result"* property of the global object.</li>
     <li>is the functional equivelant of the following code:
       <pre><code class="javascript">
-        class TryResult {
+        class Result {
           constructor(ok, error, value) {
             this.ok = ok
             this.error = error
@@ -125,10 +125,10 @@ contributors: Arthur Fiorette, Arlen Beiler
             yield this.value
           }
           static ok(value) {
-            return new TryResult(true, undefined, value)
+            return new Result(true, undefined, value)
           }
           static error(error) {
-            return new TryResult(false, error, undefined)
+            return new Result(false, error, undefined)
           }
         }
       </code></pre>