Skip to content

feat: improve PHPStan type annotations for Result interface #7

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Aug 8, 2025
Merged

feat: improve PHPStan type annotations for Result interface #7

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 5 additions & 3 deletions src/Result.php
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -16,6 +16,7 @@ interface Result
* 結果が成功（Ok）の場合に true を返します.
*
* @phpstan-assert-if-true Ok<T> $this
* @phpstan-assert-if-false Err<E> $this
*
* @return bool
*/
Expand All @@ -34,6 +35,7 @@ public function isOkAnd(callable $fn): bool;
* 結果が失敗（Err）の場合に true を返します.
*
* @phpstan-assert-if-true Err<E> $this
* @phpstan-assert-if-false Ok<T> $this
*
* @return bool
*/
Expand All @@ -51,14 +53,14 @@ public function isErrAnd(callable $fn): bool;
/**
* 成功値を返します。失敗の場合は例外を投げます.
*
* @return T
* @return ($this is Ok<T> ? T : never)
*/
public function unwrap(): mixed;

/**
* エラー値を返します。成功の場合は例外を投げます.
*
* @return E
* @return ($this is Err<E> ? E : never)
*/
public function unwrapErr(): mixed;

Expand All @@ -67,7 +69,7 @@ public function unwrapErr(): mixed;
*
* @template U
* @param U $default
* @return T|U
* @return ($this is Ok<T> ? T : U)
*/
public function unwrapOr(mixed $default): mixed;

Expand Down