Home

Welcome to the rslike wiki!

here is you find:

1. Installation
2. Adding global functions and classes
3. API

Reasons to install @rsLike/std?

1. Less undefined behavior, when using Option and Result.
2. Well tested. 100% test coverage
3. JSDoc with examples.
4. Typescript ready - d.ts types are generated with tsc.
5. first-class CJS and ESM support.
6. Zero dependencies.
7. 2kB for min+gzip and 7.6kB for minified. See in bundlefobia.
8. Deno?

Standard library

Installation

npm i @rslike/std
# or
yarn add @rslike/std
# or
pnpm add @rslike/std

Comparison package

Installation

npm i @rslike/cmp
# or
yarn add @rslike/cmp
# or
pnpm add @rslike/cmp

About cmp

cmp or Comparison package allows define your custom compares structures between each others.

Debug package

Installation

npm i @rslike/dbg
# or
yarn add @rslike/dbg
# or
pnpm add @rslike/dbg

About dbg

dbg package allows to print information about variable and it's type.

You can find the Debug API here

globals

1. Install package type (std and/or cmp)
2. In your entry file write next:

// your main file

// add global types in globalThis: Some, None, Option, Result, Ok, Err functions
import '@rslike/<package>/globals';

// rest your file

Option

part of the std package

Option is the same as for rust Option object

You can find the Option API here

Result

part of the std package

Result<T,E> is a same as for rust Result object

You can find API here

Async

part of the std package

Tries to resolve Promise<T> into Result<Option<T>, E>.

You can find API and examples here

Bind

part of the std package

Wraps function call into Result<Option<T>, E>. Easily to combine with match function

You can find API and examples here

Match

part of the std package

unwraps boolean, Option or Result and execute one of 2 callbacks depending on result.

If result is Ok, Some or true - 1 callback will be executed

If result is Err, None or false - 2 callback will be executed

You can find API and examples here