org.http4s.dom

Type members

Classlikes

sealed abstract
class FetchClientBuilder[F[_]] extends BackendBuilder[F, Client[F]]

Configure and obtain a FetchClient

Configure and obtain a FetchClient

Value Params
cache

how the request will interact with the browser’s HTTP cache

credentials

what browsers do with credentials (cookies, HTTP authentication entries, and TLS client certificates)

mode

mode you want to use for the request, e.g., cors, no-cors, or same-origin

redirect

how to handle a redirect response

referrer

referrer of the request

referrerPolicy

referrer policy to use for the request

requestTimeout

maximum duration from the submission of a request through reading the body before a timeout.

Companion
object
Companion
class
final
class FetchEventContext[F[_]]
Companion
object
Companion
class
sealed abstract
class FetchOptions extends Product with Serializable

Options to pass to Fetch when using a FetchClient

Options to pass to Fetch when using a FetchClient

Value Params
cache

how the request will interact with the browser’s HTTP cache

credentials

what browsers do with credentials (cookies, HTTP authentication entries, and TLS client certificates)

integrity

subresource integrity value of the request

keepAlive

used to allow the request to outlive the page

mode

mode you want to use for the request, e.g., cors, no-cors, or same-origin

redirect

how to handle a redirect response

referrer

referrer of the request, this can be a same-origin URL, about:client, or an empty string.

referrerPolicy

referrer policy to use for the request

requestTimeout

maximum duration from the submission of a request through reading the body before a timeout.

Companion
object
Companion
class
sealed abstract
class FetchReferrer extends Renderable

Fetch's RequestInit.referrer parameter can be one of:

Fetch's RequestInit.referrer parameter can be one of:

  • Same-origin URL
  • "about:client"
  • the empty string

To ensure same-origin URLs, we only allow relative URLs in the form of Uri.Path.

See https://fetch.spec.whatwg.org/#ref-for-dom-request-referrer%E2%91%A0

Companion
object
Companion
class

Implicits

Implicits

implicit
def blobEncoder[F[_]](implicit F: Async[F]): EntityEncoder[F, Blob]
implicit
def fileEncoder[F[_]](implicit F: Async[F]): EntityEncoder[F, File]
implicit
def readableStreamEncoder[F[_] : Async]: EntityEncoder[F, ReadableStream[Uint8Array]]