#Function: succeed()

Creates a Success result from a given value.

Passing a Promise is allowed, but it is recommended to await it before passing to succeed.

#Type Param

T

The type of the value to wrap.

#Examples

Synchronous Usage

import { 
import ResultResult } from '@praha/byethrow';

const 
const result: Result.Result<42, never>result = 
import ResultResult.
const succeed: <42>(value: 42) => Result.Result<42, never> (+1 overload)succeed(42);
// Result.Result<42, never>

With No Value

import { 
import ResultResult } from '@praha/byethrow';

const 
const result: Result.Result<void, never>result = 
import ResultResult.
const succeed: () => Result.Result<void, never> (+1 overload)succeed();
// Result.Result<void, never>

#See

• collect - For collect multiple Results into a single Result.
• sequence - For sequence multiple Results into a single Result.

#Call Signature

succeed(): Result<void, never>

#Returns

Result<void, never>

#Call Signature

succeed<T>(value): Result<T, never>

#Type Parameters

#T

T

#Parameters

#value

T

#Returns

Result<T, never>