sufa

Result

Result model with model factory and match on success & on failure callbacks.

• Features;
• Usage:
  • Prepare;
    • Create model factory;
    • Import types.
  • Commands:
    • Result factory:
      • Ok;
      • Fail.
    • Result:
      • isSuccess;
      • isFailure;
      • getData;
      • getError;
      • match.

Features

1. Data in success;
2. Error in failure;
3. Match with onSuccess & onFailure callbacks;
4. Factory.

Usage

• Prepare;
• Commands.

Prepare

Create model factory

import { ResultModelFactory, ResultModel } from 'sufa';

const resultModelFactory = new ResultModelFactory({
  Model: ResultModel
});

Import types

/**
 * @import { IResultModelFactory, IResultModel } from 'sufa'
 */

Commands

Result factory

Ok

const okResult = resultModelFactory.ok();
const okDataResult = resultModelFactory.ok('data');

Fail

const error = new Error('Message');

result.fail(error);

Result

• isSuccess;
• isFailure;
• getData;
• getError;
• match.

isSuccess

const isSuccess = result.success;

isFailure

const isFailure = result.failure;

getData

const data = result.getData();

getError

const error = result.getError();

match

result.match({
  onSuccess: () => {},
  onFailure: () => {}
});