https://github.com/dxw/result

https://github.com/dxw/result

composer govpress packagist php

Last synced: 3 months ago
JSON representation

• Host: GitHub
• URL: https://github.com/dxw/result
• Owner: dxw
• Created: 2016-07-19T13:08:27.000Z (over 8 years ago)
• Default Branch: main
• Last Pushed: 2023-07-19T11:14:54.000Z (over 1 year ago)
• Last Synced: 2024-10-11T02:39:59.444Z (4 months ago)
• Topics: composer, govpress, packagist, php
• Language: PHP
• Homepage: https://packagist.org/packages/dxw/result
• Size: 80.1 KB
• Stars: 0
• Watchers: 13
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# dxw/result

Meant to be a drop-in replacement for [nikita2206/result](https://github.com/nikita2206/result), with one addition: `wrap()`.

`wrap()` was inspired by [github.com/pkg/errors](https://godoc.org/github.com/pkg/errors#Wrap).

## Installation

    composer require dxw/result

## Usage

Returning values:

    function myfunc(): \Dxw\Result\Result

    {

        if (/* error */) {

            // getErr() will return 'something went wrong'

            return \Dxw\Result\Result::err('something went wrong');

        }

        return \Dxw\Result\Result::ok($value);

    }

Handling `Result` values:

    $result = myfunc();

    if ($result->isErr()) {

        echo sprintf("Error: %s\n", $result->getErr());

        exit(1);

    }

    $value = $result->unwrap();

Returning errors from other errors:

    function anotherfunc(): \Dxw\Result\Result

    {

        $result = myfunc();

        if ($result->isErr()) {

            // getErr() will return 'got invalid value: something went wrong'

            return $result->wrap('got invalid value');

        }

        // do something with $result->unwrap()

    }