Skip to content
brix.v2.15.0+b120c49

Search documentation

Loading search…

    Documentation menu
    Docs / APIs and dataRead Markdown
    On this page

    Typed results

    Use brix/result for expected failures callers can handle. Choose the synchronous Result workflow or Brix's awaitable ResultPromise workflow.

    If you arrived here from an API call, begin with asynchronous outcomes: executeApi returns a ResultPromise, and awaiting it gives you a success or failure to handle. Use the synchronous guide when designing your own validation or business operation that can fail without throwing an exception. Neither guide requires converting every function into a Result.

    Handle synchronous outcomes

    #

    Model tagged errors, narrow or match branches, transform values, and chain synchronous work.

    Compose asynchronous outcomes

    #

    Consume and adapt ResultPromise, use its fluent operations, and test both branches.