@chocolatelib/result v0.0.5

Result

Result handling system based loosly on rusts result handling system.

General Concept

There library contains two basic types, Result and Optional.
Result is used for a function which would normally have to throw to indicate that it failed.
Optional is uded for a function which can have no result.

The example for Result is a function which retreives some data from the internet, if there is a internet connection failure, it will return the error instead of throwing. The example for Optional is a function which needs to find something, if it doesn't find something it will return none, and if it does find something it will return some.

Usage

The state is a medium which allows passing a value with a guarentee of updates for future changes. This is done by passing a reference to the state to where it is needed.

//Declaring a function which returns a Result
async function getOnlineData(url:string):Result<Response,string>{
    let data = await Promise.race([fetch(url),new Promise((a)=>{setTimeout(a,3000,false)})])
    if (data === false) {
        return ResultError("Data timeout");
    } else {
        return ResultValid(data);
    }
}
//Calling the function
let result = await getOnlineData('Sample URL');

logStateValue(new State(1));
//Expected log output is 1

Changelog

• 0.0.5

  Added ResultOk ResultErr OptionSome OptionNone to exports to allow creating more flexible returns

• 0.0.4

  Removed all async integration, as it makes more sense to wrap the Result in a Promise than the other way around.
  Changed typescript target to ES2022 from ESNext.
  Changed vite config to emit ES2022.

• 0.0.1

  Initial Version