Packages

t

endpoints4s.xhr

Endpoints

trait Endpoints extends algebra.Endpoints with EndpointsWithCustomErrors with BuiltInErrors

Partial interpreter for algebra.Endpoints that builds a client issuing requests using XMLHttpRequest. It uses algebra.BuiltInErrors to model client and server errors.

The interpreter is partially implemented: it returns endpoint invocation results in an abstract Result type, which is yet to be defined by a more specialized interpreter. You can find such interpreters in the “known Endpoints subclasses” list.

Linear Supertypes
BuiltInErrors, EndpointsWithCustomErrors, StatusCodes, Methods, Urls, algebra.Endpoints, algebra.BuiltInErrors, algebra.EndpointsWithCustomErrors, Errors, Responses, algebra.StatusCodes, Requests, endpoints4s.SemigroupalSyntax, algebra.Methods, algebra.Urls, endpoints4s.PartialInvariantFunctorSyntax, endpoints4s.InvariantFunctorSyntax, AnyRef, Any
Known Subclasses
Endpoints, Endpoints
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Endpoints
  2. BuiltInErrors
  3. EndpointsWithCustomErrors
  4. StatusCodes
  5. Methods
  6. Urls
  7. Endpoints
  8. BuiltInErrors
  9. EndpointsWithCustomErrors
  10. Errors
  11. Responses
  12. StatusCodes
  13. Requests
  14. SemigroupalSyntax
  15. Methods
  16. Urls
  17. PartialInvariantFunctorSyntax
  18. InvariantFunctorSyntax
  19. AnyRef
  20. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Type Members

  1. final class CallbackDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. type ClientErrors = Invalid
    Definition Classes
    BuiltInErrors → Errors
  4. final class EndpointDocs extends Serializable
    Definition Classes
    EndpointsWithCustomErrors
  5. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  6. type Method = String
    Definition Classes
    Methods → Methods
  7. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  8. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  9. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  10. 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
  11. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  12. 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
  13. 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
  14. type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  15. type ResponseHeaders[A] = (XMLHttpRequest) ⇒ Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  16. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  17. 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
  18. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  19. type ServerError = Throwable
    Definition Classes
    BuiltInErrors → Errors
  20. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  21. 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
  22. 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
  23. trait Path[A] extends Url[A]

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  24. 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
  25. 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
  26. 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
  27. 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 endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs): Endpoint[A, B]
    Definition Classes
    EndpointsWithCustomErrors

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 clientErrorsResponseEntity: ResponseEntity[Invalid]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  59. final def clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
    Definition Classes
    BuiltInErrors → Errors
  60. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  61. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  62. 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
  63. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  64. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  65. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  66. 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
  67. def emptyResponse: ResponseEntity[Unit]

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  68. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  69. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  70. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  71. 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
  72. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  73. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  74. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  75. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  76. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  77. final def invalidToClientErrors(invalid: Invalid): ClientErrors
    Definition Classes
    BuiltInErrors → Errors
  78. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  79. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  80. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  81. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  82. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  83. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  84. 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
  85. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  86. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  87. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  88. 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
  89. val path: Path[Unit]
    Definition Classes
    Urls
  90. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  91. 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
  92. 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
  93. 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
  94. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  95. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  96. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  97. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  98. 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
  99. 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
  100. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  101. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  102. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  103. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  104. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  105. 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
  106. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  107. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  108. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  109. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  110. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  111. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  112. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  113. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  114. def serverErrorResponseEntity: ResponseEntity[Throwable]
    Definition Classes
    BuiltInErrors → BuiltInErrors → Errors
  115. final def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    BuiltInErrors → Errors
  116. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  117. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  118. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  119. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  120. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  121. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  122. def textResponse: ResponseEntity[String]

    Decodes a text entity

    Decodes a text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  123. final def throwableToServerError(throwable: Throwable): ServerError
    Definition Classes
    BuiltInErrors → Errors
  124. def toString(): String
    Definition Classes
    AnyRef → Any
  125. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  126. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  127. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  128. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  129. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  130. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  131. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  132. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  133. 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 BuiltInErrors

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

Inherited from algebra.Endpoints

Inherited from algebra.BuiltInErrors

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