Class OptionError

An error thrown by Option methods when operations fail due to the option's state or unexpected conditions.

This class extends AnyError with error kinds specific to Option operations, as defined in OptionErrorKind. It is typically thrown by methods like unwrap, expect, or others that enforce strict access or behavior on Some or None variants. Use it to handle failures gracefully in a type-safe manner, inspecting the OptionErrorKind to determine the cause.

Example

const opt = none<number>();
try {
  opt.unwrap();
} catch (e) {
  expect(e).toBeInstanceOf(OptionError);
  expect(e.kind).toBe(OptionErrorKind.UnwrapCalledOnNone);
  expect(e.message).toBe("`unwrap`: called on `None`");
}
Copy