CoreApi

com.alecdorrington.server.api.CoreApi
object CoreApi

These are general endpoints which are used across the entire application.

Attributes

Experimental
true
Graph
Supertypes
class Object
trait Matchable
class Any
Self type
CoreApi.type

Members list

Value members

Concrete fields

val assets: PublicEndpoint[(List[String], Option[String]), StatusCode, (Array[Byte], String, String, String), Any]

An endpoint that serves static files from the client's resources.

An endpoint that serves static files from the client's resources.

Attributes

val health: Endpoint[Unit, Unit, Unit, String, Any]

A health check endpoint that confirms the server is running and able to accept requests.

A health check endpoint that confirms the server is running and able to accept requests.

Attributes

val hotReload: Endpoint[Unit, Unit, Unit, Stream[IO, String] => Stream[IO, String], Fs2Streams[IO] & WebSockets]

An endpoint that establishes a websocket connection so that the client is able to detect when the server has been restarted, at which time the client will proceed by reloading the page.

An endpoint that establishes a websocket connection so that the client is able to detect when the server has been restarted, at which time the client will proceed by reloading the page.

Attributes

Note

Only available in development mode.

val index: Endpoint[Unit, Unit, Unit, String, Any]

Serves the index page of the website.

Serves the index page of the website.

Attributes