LowLevelEndpoints

A function that takes the information needed to build a request and returns a task yielding the information carried by the response.

Extension methods for Endpoint.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Builds an URL path from an A

Convenient methods for Paths.

Defines how to build a query string from an A

Defines how to build a query string parameter value from an A

Extension methods on QueryString.

A function that takes the information A and returns the data to create an XMLHttpRequest.

Extension methods for Request.

Extension methods for Response.

Defines how to build a path segment from an A

Builds an URL from an A

Represents the request entity as a function that is passed the underlying XMLHttpRequest (so this one can be modified in place) and returns the actual entity to use

The response can be retrieved from the XMLHttpRequest API

Callbacks indexed by URL pattern

Errors in a request built by a client

A function that, given information A and an XMLHttpRequest, returns a request entity. Also, as a side-effect, the function can set the corresponding Content-Type header on the given XMLHttpRequest.

A function that takes the information A and the XMLHttpRequest and sets up some headers on it.

Attempts to decode an A from an XMLHttpRequest’s response

A value that eventually yields an A.

Typically, concrete representation of Result will have an instance of MonadError, so that we can perform requests (sequentially and in parallel) and recover errors.

Error raised by the business logic of a server

Bad Request (400) response, with an entity of type ClientErrors.

Format of the response entity carrying the client errors.

Convert the ClientErrors type into the endpoints4s internal client error type

Helper method to perform DELETE request

Discards response entity

Define an HTTP endpoint

Helper method to perform GET request

Internal Server Error (500) response, with an entity of type ServerError.

Convert the endpoints4s internal client error type into the ClientErrors type

OK (200) Response with the given entity

Helper method to perform PATCH request

Helper method to perform POST request

Helper method to perform PUT request

Format of the response entity carrying the server error.

Convert the ServerError type into the endpoints4s internal server error type

Decodes a text entity

Convert the endpoints4s internal server error type into the ServerError type

Turns a Response[A] into a Response[Option[A]].

Interpreters represent None with an empty HTTP response whose status code is 404 (Not Found).

Sends the entity as it is

Successfully returns the underlying XMLHttpRequest, whatever its status code is

Response used by endpoints4s when decoding a request fails.

The provided implementation forwards to badRequest.

Sets up no headers on the given XMLHttpRequest

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")

Response used by endpoints4s when the business logic of an endpoint fails.

The provided implementation forwards to internalServerError

Extension methods for Endpoint.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Convenient methods for Paths.

Extension methods on QueryString.

Extension methods for Request.

Extension methods for Response.

Query string parameter containing a Boolean value

Codec for query string parameters of type Double

Path segment codec for type Double

Ability to define Int query string parameters

Path segment codec for type Int

Query string parameter containing a Long value

Path segment codec for type Long

Ability to define UUID query string parameters

Path segment codec for type UUID