Skip to content
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.

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

fix: improve Result jsdoc comments #6

Merged
merged 1 commit into from
Feb 8, 2024
Merged
Changes from all commits
Commits
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
9 changes: 7 additions & 2 deletions src/result.ts
Original file line number Diff line number Diff line change
Expand Up @@ -15,19 +15,24 @@ export class Result<T, E> {
}

/**
* Represents a failure
* Create a box representing failure
*/
static Err<const E>(err: E) {
return new Result<never, E>({ isOk: false, err });
}

/**
* Represents a success
* Create a box representing success
*/
static Ok<T>(value: T) {
return new Result<T, never>({ isOk: true, value });
}

/**
* Combine record of boxes and return either record with their unboxed values
* if all boxes represent a success or the first box representing failure
* otherwise
*/
static all<T extends Readonly<Record<string, Result<unknown, unknown>>>>(
xs: T,
): Result<
Expand Down
Loading