krustykrab

!dependencies status

Implementation of some helpers of Rust stdlib on JavaScript/TypeScript

Api reference

Implemented helpers

$3

``ts
import { Some, None } from "krustykrab";

const someOption = Some("foo");
const noneOption = None();
`

Rust reference

krustykrab reference

$3

`ts
import { Ok, Err } from "krustykrab";

const okResult = Ok("foo");
const errResult = Err("bar");
`

Rust reference

krustykrab reference

Additional helpers

$3

Panics if the value is null or undefined or returns it otherwise

`ts
import { unwrap } from "krustykrab";

const fooOrUndefined = document.getElementById('foo'); // html element or undefined
const foo = unwrap(fooOrUndefined); // exactly html element
`

$3

Returns the value if it's not null or undefined, or returns the default value

`ts
import { unwrapOr } from "krustykrab";

const foo: Partial> = { bar: 'baz' };

unwrapOr(foo.bar, 'qux'); // returns 'baz'
unwrapOr(foo.bat, 'qux'); // returns 'qux'
`

$3

Returns the value if it's not null or undefined, or computes it

`ts
import { unwrapOrElse } from "krustykrab";

const foo: Partial> = { bar: 'baz' };

unwrapOrElse(foo.bar, () => 'qux'); // returns 'baz'
unwrapOrElse(foo.bat, () => 'qux'); // returns 'qux'
`

$3

Converts Promise to Result

`ts
import { getResult } from "krustykrab";

const successResult = await getResult(Promise.resolve('foo'));
successResult.unwrap(); // returns 'foo'

const errorResult = await getResult(Promise.reject('bar'));
errorResult.unwrapErr(); // returns 'bar'
`

$3

Convert a nullable variable to Option


`ts
import { toOption } from "krustykrab";

const option = toOption('foo');
option.isNone(); // returns false;
option.unwrap(); // returns 'foo';

toOption(null).isNone(); // returns true
toOption(undefined).isNone(); // returns true
`

$3

Wrap the result of a function call with Result

`ts
import { tryCatch } from "krustykrab";

const successResult = tryCatch(() => JSON.parse('{"foo": "bar"}'));
successResult.unwrap(); // returns { foo: "bar" }

const errorResult = tryCatch(() => JSON.parse("{invalid json}"));
errorResult.isErr(); // returns true
``