Giter VIP home page Giter VIP logo

rustype's Introduction

Rustype 🦀

Type-safe variant, result and vector straight (well, almost) from Rust language. Helps to cope with situations where, for example, a value may be missing - we have a stylish API, no more boring code like if stuff == null {...} else {...}

Minified Version Types Dependency count

Install

Using npm

npm i @faramo.zayw/rustype

Using yarn

yarn add @faramo.zayw/rustype

Supporting IE11 and obsolete platforms

This library uses features like destructuring assignment, for..of and const/let declarations and doesn't ship with ES5 transpiled sources. If you aim to support browsers like IE11 and below → make sure you run Babel over your node_modules

Usage

Option<T>

import { Option } from "@faramo.zayw/rustype";

interface User {
	id: number;
	firstName: string;
	lastName: string;
	email?: string;
	phone?: string;
	age: number;
}

const defaultUser: User = { ... };
const fetchUser = (userID: number): Option<User> => { ... };

const myUser = fetchUser(1297)
	.map(({ firstName, lastName, ...props }) => ({
		username: `@${firstName}_${lastName}`,
		...props,
	}))
	.filter(({ age }) => age > 18)
	.unwrapOr({ ...defaultUser });

Result<T, E>

import { Result, Err, Ok } from "@faramo.zayw/rustype";

const safeAdd = (a: number, b: number): Result<number, string> => {
	if (Number.isSafeInteger(a) && Number.isSafeInteger(b)) {
		const sum = a + b;
		return Number.isSafeInteger(sum)
			? Ok(sum)
			: Err("The sum result is not a safe integer.");
	}

	return Err("Some of the arguments are not safe integers.");
};

console.log(safeAdd(6, 7)); // Ok(13)
console.log(safeAdd(Infinity, 7)); // Err("Some of the arguments are not safe integers.")
console.log(safeAdd(Number.MAX_SAFE_INTEGER - 1, 7)); // Err("The sum result is not a safe integer.");

Vector<T>

import { Vector } from "@faramo.zayw/rustype";

const vec = new Vec(1, 2, 3, 4, 5, 6, 7, 8, 12)
	.repeat(3)
	.map(item => item % 2 * Math.random())
	.rotateLeft(5)
	.partition((item) => item % 2 === 0)

API Docs

You can see the documentation here.

Alternatives?

  • monads - «Type safe Option, Result, and Either types; inspired by Rust.»
  • rusted - «Rust's syntax features for javascript.»
  • @pacote/option - «Option type inspired by Rust.»
  • ReScript - «The JavaScript-like language you have been waiting for.»

License

MIT

rustype's People

Contributors

faramozzayw avatar remimimimimi avatar

Stargazers

 avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar  avatar

Watchers

 avatar  avatar

rustype's Issues

Add `Set`

Add a new Set that extends from the standard Set and has the following methods:

  • isDisjoint
  • isSuperset
  • isSubset
  • difference
  • symmetricDifference
  • intersection
  • union
  • drain
  • drainFilter
  • retain
  • toArray
  • toVector

Set operations

Add safe math operations

Add the following math functions:

  • isSafeNumber
  • checkedSub
  • checkedMul
  • checkedDiv
  • checkedRem
  • checkedPow
  • saturatingSub
  • saturatingAdd
  • saturatingMul
  • saturatingPow
  • overflowingAdd
  • overflowingSub
  • overflowingMul
  • overflowingDiv
  • overflowingRem
  • isPositive
  • isNegative

Reference
BigInt

Update `Vector`

Add the following methods to the Vector class:

  • chunks
  • rchunks
  • groupBy
  • rsplit
  • splitn
  • rsplitn
  • startsWith
  • endsWith
  • dedup
  • partitionDedup
  • reject - the opposite of filter; returns the elements of collection that predicate does not return truthy for

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.