Endpoints

Type Members

abstract class Endpoint[A, B] extends AnyRef

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
implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
InvariantFunctorSyntax
type Method = String

Definition Classes
Methods → Methods
implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

Definition Classes
PartialInvariantFunctorSyntax
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
trait Request[A] extends AnyRef

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
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
implicit class ResponseExtensions[A] extends AnyRef

Definition Classes
Responses
type Result[A] = Future[A]

Maps Result to Future
Maps Result to Future

Definition Classes
Endpoints → 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
implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

Definition Classes
SemigroupalSyntax
type StatusCode = Int

Definition Classes
StatusCodes → StatusCodes
trait Url[A] extends AnyRef

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

Definition Classes
Urls

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 BadRequest: Int

Definition Classes
StatusCodes → StatusCodes
def Delete: String

Definition Classes
Methods → Methods
def Get: String

Definition Classes
Methods → Methods
def NotFound: Int

Definition Classes
StatusCodes → StatusCodes
def OK: Int

Definition Classes
StatusCodes → StatusCodes
def Options: String

Definition Classes
Methods → Methods
def Patch: String

Definition Classes
Methods → Methods
def Post: String

Definition Classes
Methods → Methods
def Put: String

Definition Classes
Methods → Methods
def Unauthorized: Int

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

Definition Classes
Any
implicit def booleanQueryString: QueryStringParam[Boolean]

Definition Classes
Urls
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
final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

Definition Classes
Requests
implicit def doubleQueryString: QueryStringParam[Double]

Definition Classes
Urls
implicit def doubleSegment: Segment[Double]

Definition Classes
Urls
implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

Definition Classes
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
def emptyResponse(docs: Documentation): Response[Unit]

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

Definition Classes
Endpoints → Responses
def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

Definition Classes
Endpoints → Endpoints
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[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

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

Definition Classes
AnyRef → Any
def hashCode(): Int

Definition Classes
AnyRef → Any
def header(name: String, docs: Documentation): RequestHeaders[String]

Definition Classes
Endpoints → Requests
implicit def intQueryString: QueryStringParam[Int]

Definition Classes
Urls
implicit def intSegment: Segment[Int]

Definition Classes
Urls
final def isInstanceOf[T0]: Boolean

Definition Classes
Any
implicit def longQueryString: QueryStringParam[Long]

Definition Classes
Urls
implicit def longSegment: Segment[Long]

Definition Classes
Urls
final def ne(arg0: AnyRef): Boolean

Definition Classes
AnyRef
final def notify(): Unit

Definition Classes
AnyRef
final def notifyAll(): Unit

Definition Classes
AnyRef
def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

Definition Classes
Endpoints → Requests
implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

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

Definition Classes
Urls
implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

Definition Classes
Urls → 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[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

Definition Classes
Requests
def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

Definition Classes
Urls → Urls
implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

Definition Classes
Urls → Urls
implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

Definition Classes
Urls → Urls
def remainingSegments(name: String, docs: Documentation): Path[String]

Definition Classes
Urls → Urls
implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

Definition Classes
Urls → Urls
implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

Definition Classes
Endpoints → Requests
implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]

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

Definition Classes
Endpoints → Requests
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]

Definition Classes
Urls → Urls
implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]

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
def textRequest(docs: Documentation): RequestEntity[String]

Definition Classes
Endpoints → Requests
def textResponse(docs: Documentation): 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
implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]

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

Definition Classes
Urls → Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Definition Classes
Urls
implicit def uuidSegment: Segment[UUID]

Definition Classes
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( ... )
def wheneverFound[A](response: Function1[XMLHttpRequest, Either[Exception, A]], notFoundDocs: Documentation): Function1[XMLHttpRequest, Either[Exception, Option[A]]]

A response decoder that maps HTTP responses having status code 404 to None, or delegates to the given response.
A response decoder that maps HTTP responses having status code 404 to None, or delegates to the given response.

Definition Classes
Endpoints → Responses

Related Doc: package future

trait Endpoints extends xhr.Endpoints

Type Members

abstract class Endpoint[A, B] extends AnyRef

implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef

type Method = String

implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef

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

trait Request[A] extends AnyRef

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

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

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

implicit class ResponseExtensions[A] extends AnyRef

type Result[A] = Future[A]

trait Segment[A] extends AnyRef

implicit class SemigroupalSyntax[A, F[_]] extends AnyRef

type StatusCode = Int

trait Url[A] extends AnyRef

Value Members

final def !=(arg0: Any): Boolean

final def ##(): Int

final def ==(arg0: Any): Boolean

def BadRequest: Int

def Delete: String

def Get: String

def NotFound: Int

def OK: Int

def Options: String

def Patch: String

def Post: String

def Put: String

def Unauthorized: Int

final def asInstanceOf[T0]: T0

implicit def booleanQueryString: QueryStringParam[Boolean]

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]

final def delete[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

implicit def doubleQueryString: QueryStringParam[Double]

implicit def doubleSegment: Segment[Double]

implicit def dummyPathToUrl[A](p: Path[A]): Url[A]

lazy val emptyHeaders: RequestHeaders[Unit]

lazy val emptyRequest: RequestEntity[Unit]

def emptyResponse(docs: Documentation): Response[Unit]

def endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]

final def eq(arg0: AnyRef): Boolean

def equals(arg0: Any): Boolean

def finalize(): Unit

final def get[UrlP, HeadersP, Out](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]

final def getClass(): Class[_]

def hashCode(): Int

def header(name: String, docs: Documentation): RequestHeaders[String]

implicit def intQueryString: QueryStringParam[Int]

implicit def intSegment: Segment[Int]

final def isInstanceOf[T0]: Boolean

implicit def longQueryString: QueryStringParam[Long]

implicit def longSegment: Segment[Long]

final def ne(arg0: AnyRef): Boolean

final def notify(): Unit

final def notifyAll(): Unit

def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]

implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]

val path: Path[Unit]

implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]

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[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]

def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]

implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]

implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]

def remainingSegments(name: String, docs: Documentation): Path[String]

implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: scala.collection.compat.Factory[A, CC[A]]): QueryStringParam[CC[A]]

implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]

implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]

implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]