#Function: map()

Applies a transformation function to the success value of a Result or ResultAsync. If the input is a Failure, it will be returned unchanged.

#Type Param

The input Result or ResultAsync.

#Type Param

The transformed success value type.

#Examples

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

const result = Result.pipe(
  Result.succeed(2),
  Result.map((x) => x * 10),
);
// { type: 'Success', value: 20 }

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

const result = Result.pipe(
  Result.fail('error'),
  Result.map((x) => x * 10),
);
// { type: 'Failure', error: 'error' }

#See

pipe - It is recommended to use this function with the pipe function for better readability and composability.

#Call Signature

map<R1, T2>(fn): (result) => ResultFor<R1, T2, InferFailure<R1>>

Defined in: functions/map.ts:44

#Type Parameters

#R1

R1 extends ResultMaybeAsync<any, any>

#T2

T2

#Parameters

#fn

(a) => T2

#Returns

(result): ResultFor<R1, T2, InferFailure<R1>>

#Parameters

#result

R1

#Returns

ResultFor<R1, T2, InferFailure<R1>>

#Call Signature

map<T1, T2>(fn): <R1>(result) => ResultFor<R1, T2, InferFailure<R1>>

Defined in: functions/map.ts:45

#Type Parameters

#T1

T1

#T2

T2

#Parameters

#fn

(a) => T2

#Returns

<R1>(result): ResultFor<R1, T2, InferFailure<R1>>

#Type Parameters

#R1

R1 extends ResultMaybeAsync<T1, any>

#Parameters

#result

R1

#Returns

ResultFor<R1, T2, InferFailure<R1>>