functional-response
Index
External modules
functional-response
Interfaces
functional-response › "Response" › Failure
Interface: Failure
Hierarchy
- Failure
Index
Properties
Properties
error
• error: string
Defined in src/Response.ts:23
functional-response › "Response" › Success
Interface: Success <T>
Type parameters
Hierarchy
- Success
Index
Properties
Properties
message
• message: string
Defined in src/Response.ts:18
payload
• payload: T
Defined in src/Response.ts:19
Modules
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
Type aliases
Variables
Functions
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:
Parameters:
Name | Type |
---|---|
either |
E.Either‹Error, A› |
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:
Parameters:
Name | Type |
---|---|
response |
Success‹A› |
Const
getStatusFromResponse
• getStatusFromResponse: function = ifElse( isSuccess, () => 200, () => 400 )
Defined in src/Response.ts:101
getStatusFromResponse :: Response -> Status
Type declaration:
▸ (response
: Response‹unknown›): Status
Parameters:
Name | Type |
---|---|
response |
Response‹unknown› |
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:
Parameters:
Name | Type |
---|---|
response |
Response‹A› |
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:
Parameters:
Name | Type |
---|---|
response |
Response‹T› |
Functions
Const
fromError
▸ fromError(error
: Error): object
Defined in src/Response.ts:59
fromError :: Error -> Failure
Parameters:
Name | Type |
---|---|
error |
Error |
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:
▸ (failure
: Failure): E
Parameters:
Name | Type |
---|---|
failure |
Failure |
Returns: any
Const
isFailure
▸ isFailure(a
: unknown): a is Failure
Defined in src/Response.ts:43
isFailure :: a -> bool
Parameters:
Name | Type |
---|---|
a |
unknown |
Returns: a is Failure
Const
isResponse
▸ isResponse(a
: unknown): a is Response
Defined in src/Response.ts:51
isResponse :: a -> bool
Parameters:
Name | Type |
---|---|
a |
unknown |
Returns: a is Response
Const
isSuccess
▸ isSuccess(a
: unknown): a is Success
Defined in src/Response.ts:35
isSuccess :: a -> bool
Parameters:
Name | Type |
---|---|
a |
unknown |
Returns: a is Success
Const
success
▸ success(a
: A): object
Defined in src/Response.ts:68
success :: a -> Success
Parameters:
Name | Type |
---|---|
a |
A |
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:
Parameters:
Name | Type |
---|---|
message |
any |
Returns: function
▸ (obj
: T): U
Parameters:
Name | Type |
---|---|
obj |
T |