https://github.com/greguz/ultres

Rust Result for JavaScript with Promise support
https://github.com/greguz/ultres

async nodejs promise result rust

Last synced: about 1 month ago
JSON representation

Rust Result for JavaScript with Promise support

• Host: GitHub
• URL: https://github.com/greguz/ultres
• Owner: greguz
• License: mit
• Created: 2023-11-29T15:45:54.000Z (about 1 year ago)
• Default Branch: master
• Last Pushed: 2024-08-22T15:45:27.000Z (4 months ago)
• Last Synced: 2024-11-07T15:17:59.741Z (about 2 months ago)
• Topics: async, nodejs, promise, result, rust
• Language: JavaScript
• Homepage: https://greguz.github.io/ultres/
• Size: 56.6 KB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# ultres

[![npm](https://img.shields.io/npm/v/ultres)](https://www.npmjs.com/package/ultres)

[![JavaScript Style Guide](https://img.shields.io/badge/code_style-standard-brightgreen.svg)](https://standardjs.com)

[![ci](https://github.com/greguz/ultres/actions/workflows/ci.yaml/badge.svg)](https://github.com/greguz/ultres/actions/workflows/ci.yaml)

[![Coverage Status](https://coveralls.io/repos/github/greguz/ultres/badge.svg?branch=master)](https://coveralls.io/github/greguz/ultres?branch=master)

Flexible and functional `Result` type for handling success and error cases.

## Naming Things Is Hard™

Result > Res ult > ult Res > **Ultres**.

Yup.

## Why

- **Zero dependencies**: banana only, no gorilla or jungle whatsoever

- **ESM**: native ESM package

- **CommonJS**: support for older runtimes

- **TypeScript**: first-class support

- **ES6**: only used ES6 features

- **Familiar APIs**: most of the idea were stolen from [Rust](https://doc.rust-lang.org/std/result/)

- **Promise support**: added `Promise`/`async` support with the `AsyncResult` lib (see docs)

## Install

```

npm i ultres

```

## Quick example

```javascript

import Result from 'ultres'

import AsyncResult from 'ultres/async'

const integer = value => {

  if (typeof value === 'bigint' || Number.isInteger(value)) {

    return Result.ok(value)

  } else if (typeof value === 'string' && /^[+-]\d+$/.test(value)) {

    return Result.ok(parseInt(value))

  } else {

    return Result.err(`Value ${value} is not an integer`)

  }

}

const double = value => value * 2

console.log(

  integer(5).map(double).unwrap() // 10

)

console.log(

  integer('-2').map(double).unwrap() // -4

)

console.log(

  integer(null).map(double).unwrapErr() // Value null is not an integer

)

const process = async value => {

  console.log(`process ${value} items`)

  return Result.ok(new Date())

}

const date = await AsyncResult.ok(integer(2))

  .andThen(process)

  .unwrap() // process 2 items

console.log(date) // 2024-08-22T15:19:04.830Z

const errInstance = await AsyncResult.ok(Promise.reject(new Error('Oh no')))

  .catchRejection()

  .unwrapErr()

console.log(errInstance.message) // Oh no

```

## Docs

See [docs website](https://greguz.github.io/ultres/).

## Donate

Thank you!

[!["Buy Me A Coffee"](https://www.buymeacoffee.com/assets/img/custom_images/orange_img.png)](https://www.buymeacoffee.com/greguz)