as-container

as-container

as-container provides some utils such as Option and Result inspired by Rust for other people to use.

APIs

Box

Box is used to wrap non-nullable(or primitive) value such as i32. Box offers all operator overloads to call the inner type operator.

Box usage scenarios are mainly used when a function or field needs to be null. This is very common in the case of generic functions and generic classes. The generics you write for reference types cannot be used for basic types, and Box is a reference type.

import { Box } from "as-container";

let box = Box.from(2);
let box2 = Box.from(1);
expect(box == box2).toStrictEqual(false);
expect(box != box2).toStrictEqual(true);

More examples can be found in unit tests

Option

Option offers some operations inspired by Rust.

import { Option } from "as-container";

const x = Option.Some("some");
expect(x.map<string>((s) => s + s).unwrap()).toBe("somesome");

More examples can be found in unit tests

Result

Result offers some operations inspired by Rust.

import { Result } from "as-container";

const x = Result.Ok<string, string>("233");
expect(x.map<string>((s) => s + s).unwrap()).toBe("233233");

More examples can be found in unit tests

Others

as-container offers two versions of Result/Option. They provide the same API, but different implementations

The default version can handle any type including primitive type. But because the primitive types need one more byte to record state, it may take more overhead.

If you always use reference types as Option/Result parameters and need better performance, then you can use the type with the same name under as-container/reference.

Changelog

<small>0.6.1 (2021-08-20)</small>

• feat: remove readonly for protect fields for option/result (#38) (304d634), closes #38
• tests: fix box test (#37) (775c6b0), closes #37