functional-response v0.1.9

functional-response

functional-response

Index

External modules

• "Response"
• "index"

functional-response

functional-response

Interfaces

functional-response › "Response" › Failure

Interface: Failure

Hierarchy

• Failure

Index

Properties

• error

Properties

error

• error: string

Defined in src/Response.ts:23

functional-response › "Response" › Success

Interface: Success <T>

Type parameters

▪ T

Hierarchy

• Success

Index

Properties

• message
• payload

Properties

message

• message: string

Defined in src/Response.ts:18

payload

• payload: T

Defined in src/Response.ts:19

Modules

functional-response › "index"

External module: "index"

Index

References

• Failure
• Response
• Status
• Success
• fromEither
• fromError
• getPayload
• getPayloadOrElse
• getStatusFromResponse
• isFailure
• isResponse
• isSuccess
• success
• toEither
• toEmptyResponse
• withMessage

References

Failure

• Failure:

Response

• Response:

Status

• Status:

Success

• Success:

fromEither

• fromEither:

fromError

• fromError:

getPayload

• getPayload:

getPayloadOrElse

• getPayloadOrElse:

getStatusFromResponse

• getStatusFromResponse:

isFailure

• isFailure:

isResponse

• isResponse:

isSuccess

• isSuccess:

success

• success:

toEither

• toEither:

toEmptyResponse

• toEmptyResponse:

withMessage

• withMessage:

functional-response › "Response"

External module: "Response"

Index

Interfaces

• Failure
• Success

Type aliases

• Response
• Status

Variables

• fromEither
• getPayload
• getStatusFromResponse
• toEither
• toEmptyResponse

Functions

• fromError
• getPayloadOrElse
• isFailure
• isResponse
• isSuccess
• success
• withMessage

Type aliases

Response

Ƭ Response: Success‹T› | Failure

Defined in src/Response.ts:26

Status

Ƭ Status: 400 | 200

Defined in src/Response.ts:28

Variables

Const fromEither

• fromEither: function = ifElse( E.isRight, pipe(prop('right'), success), pipe(prop('left'), fromError) )

Defined in src/Response.ts:78

fromEither :: Either Error a -> Response a

Type declaration:

▸ <A>(either: E.Either‹Error, A›): Response‹A›

Type parameters:

▪ A

Parameters:

Const getPayload

• getPayload: function = prop('payload')

Defined in src/Response.ts:127

getPayload :: Success a -> a

Type declaration:

▸ <A>(response: Success‹A›): A

Type parameters:

▪ A

Parameters:

Const getStatusFromResponse

• getStatusFromResponse: function = ifElse( isSuccess, () => 200, () => 400 )

Defined in src/Response.ts:101

getStatusFromResponse :: Response -> Status

Type declaration:

▸ (response: Response‹unknown›): Status

Parameters:

Const toEither

• toEither: function = ifElse( isSuccess, E.right, pipe((failure: Failure): Error => new Error(failure.error), E.left) )

Defined in src/Response.ts:114

toEither :: Response -> Either Response Error

Type declaration:

▸ <A>(response: Response‹A›): E.Either‹Error, Success‹A››

Type parameters:

▪ A

Parameters:

Const toEmptyResponse

• toEmptyResponse: function = unless(isFailure, () => undefined)

Defined in src/Response.ts:145

toEmptyResponse :: Response -> Empty | Failure

Type declaration:

▸ <T>(response: Response‹T›): Failure | undefined

Type parameters:

▪ T

Parameters:

Functions

Const fromError

▸ fromError(error: Error): object

Defined in src/Response.ts:59

fromError :: Error -> Failure

Parameters:

Returns: object

• error: string = error.message

Const getPayloadOrElse

▸ getPayloadOrElse(response: Failure | Success‹A›, onFailure: function): any

Defined in src/Response.ts:137

getPayloadOrElse :: Response a -> a

Parameters:

▪ response: Failure | Success‹A›

▪ onFailure: function

▸ (failure: Failure): E

Parameters:

Returns: any

Const isFailure

▸ isFailure(a: unknown): a is Failure

Defined in src/Response.ts:43

isFailure :: a -> bool

Parameters:

Returns: a is Failure

Const isResponse

▸ isResponse(a: unknown): a is Response

Defined in src/Response.ts:51

isResponse :: a -> bool

Parameters:

Returns: a is Response

Const isSuccess

▸ isSuccess(a: unknown): a is Success

Defined in src/Response.ts:35

isSuccess :: a -> bool

Parameters:

Returns: a is Success

Const success

▸ success(a: A): object

Defined in src/Response.ts:68

success :: a -> Success

Parameters:

Returns: object

• message: string = ""

• payload: A = a

Const withMessage

▸ withMessage<A>(message: any): function

Defined in src/Response.ts:93

withMessage :: string -> Reader (Response a) (Response a)`

Type parameters:

▪ A

Parameters:

Returns: function

▸ (obj: T): U

Parameters: