result-type.md

Result Type

Solana Suite's responses are implemented using the Result Type, a pattern commonly used in functional programming languages like Rust. Handling responses from functions can be done as follows. Additionally, exceptions occurring internally are converted to Result Type using Try().

example

type guard pattern

// success, ok  => ex1.value
// failed,  err => ex1.error

ex1.isOk && console.log("# ex1: ", ex1.value);

if (ex1.isOk) {
  console.log("# ex1: ", ex1.value);
} else if (ex1.isErr) {
  console.log("# ex1 error: ", ex1.error);
}

unwrap pattern

ex2.unwrap());

map pattern

const mapped = ex3
   .map(
     (value: number) => number * 100,
     (error: Error) => new Error(error.message),
   )

match pattern

ex4.match(
  (value: number) => console.log('# value: ', value),
  (error: Error) => console.error(error),
);