#Function: assertFailure()

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

const 
const result: Result.Result<never, string>result = 
import ResultResult.
const fail: <string>(error: string) => Result.Result<never, string> (+1 overload)fail('error');
const 
const failure: Result.Failure<string>failure = 
import ResultResult.
const assertFailure: <Result.Result<never, string>>(result: Result.Result<never, string>) => Result.Failure<string> (+1 overload)assertFailure(
const result: Result.Result<never, string>result);
// failure: { type: 'Failure', error: 'error' }

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

const 
const result: Result.Result<number, never>result = 
import ResultResult.
const succeed: <number>(value: number) => Result.Result<number, never> (+1 overload)succeed(42);
import ResultResult.
const assertFailure: <Result.ResultAsync<never, any>>(result: Result.ResultAsync<never, any>) => Promise<Result.Failure<any>> (+1 overload)assertFailure(result); // throws Error
No overload matches this call.
  Overload 1 of 2, '(result: ResultAsync<never, any>): Promise<Failure<any>>', gave the following error.
    Argument of type 'Result<number, never>' is not assignable to parameter of type 'ResultAsync<never, any>'.
      Type 'Failure<never>' is missing the following properties from type 'Promise<Result<never, any>>': then, catch, finally, [Symbol.toStringTag]
  Overload 2 of 2, '(result: Result<never, any>): Failure<any>', gave the following error.
    Argument of type 'Result<number, never>' is not assignable to parameter of type 'Result<never, any>'.
      Type 'Success<number>' is not assignable to type 'Result<never, any>'.
        Type 'Success<number>' is not assignable to type 'Success<never>'.
          Type 'number' is not assignable to type 'never'.

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

const 
const getResult: () => Result.Result<number, string>getResult = (): 
import ResultResult.
type Result<T, E> = Result.Success<T> | Result.Failure<E>
A union type representing either a success or a failure.
@typeParamT  - The type of the Success value.@typeParamE  - The type of the Failure value.@example
import { Result } from '@praha/byethrow';

const doSomething = (): Result.Result<number, string> => {
  return Math.random() > 0.5
    ? { type: 'Success', value: 10 }
    : { type: 'Failure', error: 'Oops' };
};
@categoryCore  TypesResult<number, string> => 
import ResultResult.
const fail: <string>(error: string) => Result.Result<never, string> (+1 overload)fail('error');
const 
const value: anyvalue = 
import ResultResult.
const pipe: <Result.Result<number, string>, Result.Result<never, string>, Result.Failure<any>, any>(a: Result.Result<number, string>, ab: (a: Result.Result<number, string>) => Result.Result<never, string>, bc: (b: Result.Result<never, string>) => Result.Failure<any>, cd: (c: Result.Failure<any>) => any) => any (+25 overloads)pipe(
  
const getResult: () => Result.Result<number, string>getResult(),
  
import ResultResult.
const andThen: <Result.Result<number, string>, Result.Result<never, string>>(fn: (a: number) => Result.Result<never, string>) => (result: Result.Result<number, string>) => Result.Result<never, string> (+1 overload)andThen(() => 
import ResultResult.
const fail: <string>(error: string) => Result.Result<never, string> (+1 overload)fail('die')),
  
import ResultResult.
const assertFailure: {
    <R extends Result.ResultAsync<never, any>>(result: R): Promise<Result.Failure<Result.InferFailure<R>>>;
    <R extends Result.Result<never, any>>(result: R): Result.Failure<Result.InferFailure<R>>;
}
Asserts that a
Result
or
ResultAsync
is a
Failure
and returns it.
If the result is a
Success 
, throws an error.
@function@typeParamE  - The type of the error value.@paramresult  - The Result or ResultAsync to assert as a Failure.@returnsThe  Failure result or a Promise of Success  result.@throws{Error} If the result is a Success .@example
import { Result } from '@praha/byethrow';

const result = Result.fail('error');
const failure = Result.assertFailure(result);
// failure: { type: 'Failure', error: 'error' }
@example
Throws  on Success
//@errors
: 2769
import { Result } from '@praha/byethrow';
const result = Result.succeed(42);
Result.assertFailure(result); // throws Error
@example
Safe  unwrap with assertFailure
import { Result } from '@praha/byethrow';

const getResult = (): Result.Result<number, string> => Result.fail('error');
const value = Result.pipe(
getResult(),
Result.andThen(() => Result.fail('die')),
Result.assertFailure,
Result.unwrapError(), // Safe unwrap after assertion
);
@seeunwrapError  - Use with assertFailure to safely unwrap error values.@categoryAssertionsassertFailure,
  
import ResultResult.
const unwrapError: <Result.Failure<any>>() => (result: Result.Failure<any>) => any (+3 overloads)unwrapError(), // Safe unwrap after assertion
);