Packages

t

endpoints4s.xhr

MuxEndpoints

trait MuxEndpoints extends algebra.MuxEndpoints with EndpointsWithCustomErrors

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. MuxEndpoints
  2. EndpointsWithCustomErrors
  3. StatusCodes
  4. Methods
  5. Urls
  6. MuxEndpoints
  7. EndpointsWithCustomErrors
  8. Errors
  9. Responses
  10. StatusCodes
  11. Requests
  12. SemigroupalSyntax
  13. Methods
  14. Urls
  15. PartialInvariantFunctorSyntax
  16. InvariantFunctorSyntax
  17. AnyRef
  18. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. abstract class Endpoint[A, B] extends (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
    EndpointsWithCustomErrors
  2. 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
    EndpointsWithCustomErrors
  3. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  4. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  5. abstract type ClientErrors
    Definition Classes
    Errors
  6. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  7. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  8. type Method = String
    Definition Classes
    Methods → Methods
  9. abstract type MuxEndpoint[Req <: MuxRequest, Resp, Transport]
    Definition Classes
    MuxEndpoints
  10. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  11. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  12. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  13. 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
    EndpointsWithCustomErrors → Requests
  14. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  15. 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
    EndpointsWithCustomErrors → Requests
  16. type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]

    Attempts to decode an A from an XMLHttpRequest’s response

    Attempts to decode an A from an XMLHttpRequest’s response

    Definition Classes
    EndpointsWithCustomErrors → Responses
  17. type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  18. type ResponseHeaders[A] = (XMLHttpRequest) ⇒ Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  19. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  20. 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
    EndpointsWithCustomErrors
  21. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  22. abstract type ServerError
    Definition Classes
    Errors
  23. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  24. trait Path[A] extends Url[A]

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  25. 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
  26. 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
  27. 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
  28. trait Url[A] extends AnyRef

    Builds an URL from an A

    Builds an URL from an A

    Definition Classes
    Urls

Abstract Value Members

  1. abstract def clientErrorsResponseEntity: ResponseEntity[ClientErrors]
    Definition Classes
    Errors
  2. abstract def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    Errors
  3. abstract def endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors
  4. abstract def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    Errors
  5. abstract def muxEndpoint[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport]): MuxEndpoint[Req, Resp, Transport]
    Definition Classes
    MuxEndpoints
  6. abstract def serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  7. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  8. abstract def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    Errors

Concrete Value Members

  1. final def !=(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int
    Definition Classes
    AnyRef → Any
  3. final def ==(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  4. def Accepted: Int
    Definition Classes
    StatusCodes → StatusCodes
  5. def AlreadyReported: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Conflict: Int
    Definition Classes
    StatusCodes → StatusCodes
  8. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def Delete: String
    Definition Classes
    Methods → Methods
  10. def ExpectationFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def FailedDependency: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def Get: String
    Definition Classes
    Methods → Methods
  14. def Gone: Int
    Definition Classes
    StatusCodes → StatusCodes
  15. def IMUsed: Int
    Definition Classes
    StatusCodes → StatusCodes
  16. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  17. def LengthRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  18. def Locked: Int
    Definition Classes
    StatusCodes → StatusCodes
  19. def MethodNotAllowed: Int
    Definition Classes
    StatusCodes → StatusCodes
  20. def MisdirectedRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  21. def MultiStatus: Int
    Definition Classes
    StatusCodes → StatusCodes
  22. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  23. def NonAuthoritativeInformation: Int
    Definition Classes
    StatusCodes → StatusCodes
  24. def NotAcceptable: Int
    Definition Classes
    StatusCodes → StatusCodes
  25. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  26. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  27. def NotModified: Int
    Definition Classes
    StatusCodes → StatusCodes
  28. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  29. def Options: String
    Definition Classes
    Methods → Methods
  30. def PartialContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  31. def Patch: String
    Definition Classes
    Methods → Methods
  32. def PayloadTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  33. def PaymentRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  34. def Post: String
    Definition Classes
    Methods → Methods
  35. def PreconditionFailed: Int
    Definition Classes
    StatusCodes → StatusCodes
  36. def PreconditionRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  37. def ProxyAuthenticationRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  38. def Put: String
    Definition Classes
    Methods → Methods
  39. def RangeNotSatisfiable: Int
    Definition Classes
    StatusCodes → StatusCodes
  40. def RequestHeaderFieldsTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  41. def RequestTimeout: Int
    Definition Classes
    StatusCodes → StatusCodes
  42. def ResetContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  43. def TooEarly: Int
    Definition Classes
    StatusCodes → StatusCodes
  44. def TooManyRequests: Int
    Definition Classes
    StatusCodes → StatusCodes
  45. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  46. def UnavailableForLegalReasons: Int
    Definition Classes
    StatusCodes → StatusCodes
  47. def UnprocessableEntity: Int
    Definition Classes
    StatusCodes → StatusCodes
  48. def UnsupportedMediaType: Int
    Definition Classes
    StatusCodes → StatusCodes
  49. def UpgradeRequired: Int
    Definition Classes
    StatusCodes → StatusCodes
  50. def UriTooLong: Int
    Definition Classes
    StatusCodes → StatusCodes
  51. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  52. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  53. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  54. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  55. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  56. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  57. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  58. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  59. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  60. final def delete[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  61. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  62. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  63. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  64. lazy val emptyRequestHeaders: RequestHeaders[Unit]

    Sets up no headers on the given XMLHttpRequest

    Sets up no headers on the given XMLHttpRequest

    Definition Classes
    EndpointsWithCustomErrors → Requests
  65. def emptyResponse: ResponseEntity[Unit]

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  66. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  67. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  68. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  69. final def get[UrlP, HeadersP, Out](url: Url[UrlP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUH: Tupler.Aux[UrlP, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  70. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  71. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  72. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  73. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  74. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  75. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  76. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  77. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  78. final def muxPerformXhr[Req <: MuxRequest, Resp, Transport](request: Request[Transport], response: Response[Transport], req: Req)(onload: (Either[Throwable, muxPerformXhr.Req.Response]) ⇒ Unit, onError: (XMLHttpRequest) ⇒ Unit)(implicit encoder: Encoder[Req, Transport], decoder: Decoder[Transport, Resp]): Unit
    Attributes
    protected
  79. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  80. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  81. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  82. final def ok[A, B, R](entity: ResponseEntity[A], docs: Documentation, headers: ResponseHeaders[B])(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    Responses
  83. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  84. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  85. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  86. final def patch[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  87. val path: Path[Unit]
    Definition Classes
    Urls
  88. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  89. final def performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) ⇒ Unit, onerror: (XMLHttpRequest) ⇒ Unit): Unit
    Attributes
    protected
    Definition Classes
    EndpointsWithCustomErrors
  90. final def post[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  91. final def put[UrlP, BodyP, HeadersP, UrlAndBodyPTupled, Out](url: Url[UrlP], entity: RequestEntity[BodyP], docs: Documentation, headers: RequestHeaders[HeadersP])(implicit tuplerUB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerUBH: Tupler.Aux[UrlAndBodyPTupled, HeadersP, Out]): Request[Out]
    Definition Classes
    Requests
  92. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  93. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  94. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  95. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  96. 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
  97. def request[A, B, C, AB, Out](method: Method, url: Url[A], entity: RequestEntity[B], docs: Documentation, headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler.Aux[AB, C, Out]): Request[Out]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  98. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  99. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  100. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  101. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  102. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  103. def response[A, B, R](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation = None, headers: ResponseHeaders[B] = emptyResponseHeaders)(implicit tupler: Tupler.Aux[A, B, R]): Response[R]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  104. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  105. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  106. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  107. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  108. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  109. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  110. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  111. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  112. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  113. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  114. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  115. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  116. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  117. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  118. def textResponse: ResponseEntity[String]

    Decodes a text entity

    Decodes a text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  119. def toString(): String
    Definition Classes
    AnyRef → Any
  120. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  121. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  122. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  123. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  124. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  125. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  126. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  127. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  128. object EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors

Deprecated Value Members

  1. def finalize(): Unit
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] ) @Deprecated
    Deprecated

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.MuxEndpoints

Inherited from algebra.EndpointsWithCustomErrors

Inherited from Errors

Inherited from Responses

Inherited from algebra.StatusCodes

Inherited from Requests

Inherited from endpoints4s.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints4s.PartialInvariantFunctorSyntax

Inherited from endpoints4s.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped