ApiResponse (TDesu.FSharp)

ApiResponse Module

Standard API response wrapper. Bridges HTTP responses and F# Result.

Type	Description
T<'TData, 'TError>	API response with data on success, error on failure.

Function or value Description


                
                  
                    
                      ApiResponse.error err

Full Usage: ApiResponse.error err

Parameters:

err : 'TError

Returns: T<'TData, 'TError>
Modifiers: inline
Type parameters: 'TError, 'TData

Creates an error response. The error value for the failure response.


                
                  
                    
                      ApiResponse.ofResult result

Full Usage: ApiResponse.ofResult result

Parameters:

result : Result<'TData, 'TError>

Returns: T<'TData, 'TError>

Converts a Result to an API response. The Result value to convert.


                
                  
                    
                      ApiResponse.ok data

Full Usage: ApiResponse.ok data

Parameters:

data : 'TData

Returns: T<'TData, 'TError>
Modifiers: inline
Type parameters: 'TData, 'TError

Creates a success response. The data payload for the success response.


                
                  
                    
                      ApiResponse.toResult response

Full Usage: ApiResponse.toResult response

Parameters:

response : T<'TData, 'TError> - The API response to convert.

Returns: Result<'TData, 'TError>

Converts an API response to a Result.

InvalidOperationException When Success=true but Data is None.