https://github.com/xxlabaza/result

A result container
https://github.com/xxlabaza/result

container nodejs result

Last synced: 14 days ago
JSON representation

A result container

• Host: GitHub
• URL: https://github.com/xxlabaza/result
• Owner: xxlabaza
• License: apache-2.0
• Created: 2020-06-06T18:29:30.000Z (over 4 years ago)
• Default Branch: master
• Last Pushed: 2023-01-06T08:09:11.000Z (almost 2 years ago)
• Last Synced: 2024-09-08T14:57:09.184Z (2 months ago)
• Topics: container, nodejs, result
• Language: TypeScript
• Size: 1.19 MB
• Stars: 0
• Watchers: 2
• Forks: 0
• Open Issues: 14
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE

Awesome Lists containing this project

README

        

# Overview

[![Build Status](https://travis-ci.com/xxlabaza/result.svg?branch=master)](https://travis-ci.com/xxlabaza/result)

`Result` - is a value that represents either a success or a failure, including an associated value in each case.

## Usage

> installation:

>

> ```bash

> $> npm install --save @xxlabaza/result

> ```

Create `Success` or `Failure` instances with the **success** and **failure** functions.

```typescript

import { success, failure } from '@xxlabaza/result'

// something awesome happend

const yesss = success(someAesomeValue)

// moments later ...

const mappedYes = yesss.map(doingSuperUsefulStuff)

// @xxlabaza/result uses type-guards to differentiate between Success and Failure instances

// Mode info: https://www.typescriptlang.org/docs/handbook/advanced-types.html#type-guards-and-differentiating-types

if (mappedYes.isSuccess()) {

  // using type guards, we can access an Success instance's `value` field

  doStuffWith(mappedYes.value)

} else {

  // because of type guards

  // typescript knows that mappedYes is an Failure instance and thus has a `error` field

  doStuffWith(mappedYes.error)

}

```

`Result` is defined as follows:

```typescript

type Result = Success | Failure

```

`Ok`: contains the success value of type `T`

`Err`: contains the failure value of type `E`

## Development

These instructions will get you a copy of the project up and running on your local machine for development and testing purposes.

### Building

To build the project, do the following:

```bash

$> npm run build

...

```

### Running the tests

To run the project's test, do the following:

```bash

$> npm test

...

Test Suites: 2 passed, 2 total

Tests:       12 passed, 12 total

Snapshots:   0 total

Time:        1.232 s, estimated 2 s

Ran all test suites.

```

## Changelog

To see what has changed in recent versions of the project, see the [changelog](./CHANGELOG.md) file.

## Contributing

Please read [contributing](./CONTRIBUTING.md) file for details on my code of conduct, and the process for submitting pull requests to me.

## Versioning

We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/appulse-projects/utils-java/tags).

## Authors

* **[Artem Labazin](https://github.com/xxlabaza)** - creator and the main developer

## License

This project is licensed under the Apache License 2.0 License - see the [license](./LICENSE) file for details