@kozderka/railway v0.0.0-alpha.3

Railway oriented programming in TypeScript

Introduction

Package includes types, interfaces and functions for support of railway oriented programming.

Installation

npm install @kozderka/railway

Documentation

Table of Contents

• Success
  • Properties
• Failure
  • Properties
• Result
• success
  • Parameters
• failure
  • Parameters
• isSuccess
  • Parameters
• isFailure
  • Parameters
• getValue
  • Parameters
• map
  • Parameters
• chain
  • Parameters
• tee
  • Parameters

Success

Type: Object

Properties

• tag "success"
• value T

Failure

Type: Object

Properties

• tag "failure"
• error T

Result

Type: (Success\ | Failure\)

success

Parameters

• value T

Returns Success\

failure

Parameters

• error T

Returns Failure\

isSuccess

Parameters

• result Result

Returns boolean

isFailure

Parameters

• result Result

Returns boolean

getValue

Parameters

• result Result\<T, U>

Returns T

map

Parameters

• f function (any): any

Returns function (any): Success\

chain

Parameters

• f function (any): any

Returns function (any): any

tee

Parameters

• f function (any): any

Returns function (Result\<T, U>): Result\<T, U>