bocmah/psalm-reactphp-promise-plugin

Psalm plugin for react/promise

0.1.1 2021-01-27 20:40 UTC

Requires

• vimeo/psalm: ^4.2

Requires (Dev)

• phpunit/phpunit: ^7.2
• react/promise: ^2.8.0
• squizlabs/php_codesniffer: ^3.3

MIT

• Artem Trushkin

README

A Psalm plugin for reactphp/promise.

Overview

This package brings support for template parameters in PromiseInterface. So you can type-hint resolution template parameter, e.g. PromiseInterface<User> instead of plain PromiseInterface.

It also adds an otherwise() method to PromiseInterface as a stub, which allows Psalm to recognize constructs like

$promise
    ->then(
        function () {
            echo 'Success' . PHP_EOL;
        }
    )
    ->otherwise(
        function (\Throwable $error) {
            echo 'Failure: ' . $error->getMessage() . PHP_EOL
        }
    );

Prerequisites

You should have Psalm installed.

Installation

Install plugin as a dev dependency via composer:

composer require --dev bocmah/psalm-reactphp-promise-plugin

Then enable the plugin:

./vendor/bin/psalm-plugin enable bocmah/psalm-reactphp-promise-plugin