Assets

Type Members

case class AssetPath(path: String, name: String) extends Product with Serializable
```
// foo/bar/baz-123abc
AssetPath("foo/bar", "baz")
```
type AssetRequest = AssetPath

As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.
As a client, we just need to give the path of the asset we are interested in, the web browser will automatically set HTTP headers to handle gzip compression (Accept-Encoding) and decompress the response.

Definition Classes
Assets → Assets
type AssetResponse = ArrayBuffer

As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer
As we request the asset via an XMLHttpRequest, we get its content as an ArrayBuffer

Definition Classes
Assets → Assets
type Endpoint[A, B] = Function1[A, Result[B]]

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

Definition Classes
Endpoints → Endpoints
type Method = String

Definition Classes
Methods → Methods
abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

Definition Classes
Endpoints
trait Path[A] extends Url[A]

Builds an URL path from an A
Builds an URL path from an A

Definition Classes
Urls
implicit class PathOps[A] extends AnyRef

Definition Classes
Urls
trait QueryString[A] extends AnyRef

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

Definition Classes
Urls
implicit class QueryStringOps[A] extends AnyRef

Definition Classes
Urls
trait QueryStringParam[A] extends AnyRef

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

Definition Classes
Urls
type Request[A] = Function1[A, (XMLHttpRequest, Option[Any])]

A function that takes the information A and returns an XMLHttpRequest with an optional request entity.
A function that takes the information A and returns an XMLHttpRequest with an optional request entity. If provided, the request entity must be compatible with the send method of XMLHttpRequest.

Definition Classes
Endpoints → Requests
type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]

A function that, given information A and an XMLHttpRequest, returns a request entity.
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.

Definition Classes
Endpoints → Requests
type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]

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

Definition Classes
Endpoints → Requests
type Response[A] = Function1[XMLHttpRequest, Either[Exception, A]]

Attempts to decode an A from an XMLHttpRequest’s response
Attempts to decode an A from an XMLHttpRequest’s response

Definition Classes
Endpoints → Responses
abstract type Result[A]

A value that eventually yields an A.
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.

Definition Classes
Endpoints
trait Segment[A] extends AnyRef

Defines how to build a path segment from an A
Defines how to build a path segment from an A

Definition Classes
Urls
trait Url[A] extends AnyRef

Builds an URL from an A
Builds an URL from an A

Definition Classes
Urls

Abstract Value Members

abstract def digests: Map[String, String]

Definition Classes
Assets
abstract def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

Definition Classes
Endpoints
abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

Definition Classes
Endpoints

Concrete Value Members

final def !=(arg0: Any): Boolean

Definition Classes
AnyRef → Any
final def ##(): Int

Definition Classes
AnyRef → Any
final def ==(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def Delete: String

Definition Classes
Methods → Methods
def Get: String

Definition Classes
Methods → Methods
def Post: String

Definition Classes
Methods → Methods
def Put: String

Definition Classes
Methods → Methods
final def asInstanceOf[T0]: T0

Definition Classes
Any
def asset(path: String, name: String): AssetRequest

Convenient constructor for building an AssetRequest from its path and name.
Convenient constructor for building an AssetRequest from its path and name.
```
myAssetsEndpoint(asset("foo/bar", "baz"))
```
lazy val assetSegments: Path[AssetPath]

Encodes an AssetPath as a request path.
Encodes an AssetPath as a request path. Throws an exception if the asset digest is not found.

Definition Classes
Assets → Assets
def assetsEndpoint(url: Url[AssetPath]): Endpoint[AssetRequest, AssetResponse]

An endpoint for requesting assets.
An endpoint for requesting assets.
If the server fails to find the requested asset, this endpoint returns a failed response.
url
URL description
returns
An HTTP endpoint for requesting assets

Definition Classes
Assets → Assets
def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

Definition Classes
Urls → Urls
def clone(): AnyRef

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( ... )
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

Definition Classes
Urls → Urls
lazy val emptyHeaders: RequestHeaders[Unit]

Sets up no headers on the given XMLHttpRequest
Sets up no headers on the given XMLHttpRequest

Definition Classes
Endpoints → Requests
lazy val emptyRequest: RequestEntity[Unit]

Definition Classes
Endpoints → Requests
lazy val emptyResponse: Response[Unit]

Successfully decodes no information from a response
Successfully decodes no information from a response

Definition Classes
Endpoints → Responses
final def eq(arg0: AnyRef): Boolean

Definition Classes
AnyRef
def equals(arg0: Any): Boolean

Definition Classes
AnyRef → Any
def finalize(): Unit

Attributes
protected[java.lang]
Definition Classes
AnyRef
Annotations
@throws( classOf[java.lang.Throwable] )
final def get[A, B](url: Url[A], headers: RequestHeaders[B])(implicit tuplerAC: Tupler[A, B]): Request[Out]

Definition Classes
Requests
final def getClass(): Class[_]

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
implicit lazy val intQueryString: QueryStringParam[Int]

Definition Classes
Urls → Urls
implicit lazy val intSegment: Segment[Int]

Definition Classes
Urls → Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit lazy val longQueryString: QueryStringParam[Long]

Definition Classes
Urls → Urls
implicit lazy val longSegment: Segment[Long]

Definition Classes
Urls → Urls
final def muxPerformXhr[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport], req: Req)(onload: (Either[Throwable, Endpoints.muxPerformXhr.Req.Response]) ⇒ Unit, onError: (XMLHttpRequest) ⇒ Unit)(implicit encoder: Encoder[Req, Transport], decoder: Decoder[Transport, Resp]): Unit

Attributes
protected
Definition Classes
Endpoints
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

Definition Classes
Urls → Urls
val path: Path[Unit]

Definition Classes
Urls
final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Exception, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit

Attributes
protected
Definition Classes
Endpoints
final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Definition Classes
Requests
def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

Definition Classes
Endpoints → Requests
def segment[A](implicit s: Segment[A]): Path[A]

Definition Classes
Urls → Urls
def staticPathSegment(segment: String): Path[Unit] with Serializable

Definition Classes
Urls → Urls
implicit lazy val stringQueryString: QueryStringParam[String]

Definition Classes
Urls → Urls
implicit lazy val stringSegment: Segment[String]

Definition Classes
Urls → Urls
final def synchronized[T0](arg0: ⇒ T0): T0

Definition Classes
AnyRef
lazy val textResponse: Response[String]

Successfully decodes string information from a response
Successfully decodes string information from a response

Definition Classes
Endpoints → Responses
def toString(): String

Definition Classes
AnyRef → Any
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Definition Classes
Urls → Urls
final def wait(): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long, arg1: Int): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )
final def wait(arg0: Long): Unit

Definition Classes
AnyRef
Annotations
@throws( ... )

Related Doc: package xhr

trait Assets extends algebra.Assets with Endpoints

Type Members

case class AssetPath(path: String, name: String) extends Product with Serializable

type AssetRequest = AssetPath

type AssetResponse = ArrayBuffer

type Endpoint[A, B] = Function1[A, Result[B]]

type Method = String

abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]

trait Path[A] extends Url[A]

implicit class PathOps[A] extends AnyRef

trait QueryString[A] extends AnyRef

implicit class QueryStringOps[A] extends AnyRef

trait QueryStringParam[A] extends AnyRef

type Request[A] = Function1[A, (XMLHttpRequest, Option[Any])]

type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]

type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]

type Response[A] = Function1[XMLHttpRequest, Either[Exception, A]]

abstract type Result[A]

trait Segment[A] extends AnyRef

trait Url[A] extends AnyRef

Abstract Value Members

abstract def digests: Map[String, String]

abstract def endpoint[A, B](request: Request[A], response: Response[B]): Endpoint[A, B]

abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]

Concrete Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def Delete: String

def Get: String

def Post: String

def Put: String

final def asInstanceOf[T0]: T0

def asset(path: String, name: String): AssetRequest

lazy val assetSegments: Path[AssetPath]

def assetsEndpoint(url: Url[AssetPath]): Endpoint[AssetRequest, AssetResponse]

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]

def clone(): AnyRef

def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]

lazy val emptyHeaders: RequestHeaders[Unit]

lazy val emptyRequest: RequestEntity[Unit]

lazy val emptyResponse: Response[Unit]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[A, B](url: Url[A], headers: RequestHeaders[B])(implicit tuplerAC: Tupler[A, B]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

implicit lazy val intQueryString: QueryStringParam[Int]

implicit lazy val intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

implicit lazy val longQueryString: QueryStringParam[Long]

implicit lazy val longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optQs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[Option[A]]

val path: Path[Unit]

final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Exception, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit

final def post[A, B, C, AB](url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def qs[A](name: String)(implicit value: QueryStringParam[A]): QueryString[A]

def request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]

def segment[A](implicit s: Segment[A]): Path[A]

def staticPathSegment(segment: String): Path[Unit] with Serializable

implicit lazy val stringQueryString: QueryStringParam[String]

implicit lazy val stringSegment: Segment[String]

final def synchronized[T0](arg0: ⇒ T0): T0

lazy val textResponse: Response[String]

def toString(): String

def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

final def wait(): Unit

final def wait(arg0: Long, arg1: Int): Unit

final def wait(arg0: Long): Unit

Inherited from Endpoints

Inherited from Methods

Inherited from Urls

Inherited from algebra.Assets

Inherited from algebra.Endpoints