Packages

t

endpoints4s.xhr

JsonEntitiesFromCodecs

trait JsonEntitiesFromCodecs extends EndpointsWithCustomErrors with algebra.JsonEntitiesFromCodecs

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntitiesFromCodecs
  2. JsonEntitiesFromCodecs
  3. JsonCodecs
  4. JsonEntities
  5. EndpointsWithCustomErrors
  6. StatusCodes
  7. Methods
  8. Urls
  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. 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. abstract type JsonCodec[A]
    Definition Classes
    JsonCodecs
  9. type JsonRequest[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  10. type JsonResponse[A] = JsonCodec[A]
    Definition Classes
    JsonCodecs → JsonEntities
  11. type Method = String
    Definition Classes
    Methods → Methods
  12. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  13. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  14. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  15. 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
  16. implicit class RequestEntitySyntax[A] extends AnyRef
    Definition Classes
    Requests
  17. 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
  18. 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
  19. type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. type ResponseHeaders[A] = (XMLHttpRequest) ⇒ Validated[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  22. 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
  23. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  24. abstract type ServerError
    Definition Classes
    Errors
  25. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  26. trait Path[A] extends Url[A]

    Builds an URL path from an A

    Builds an URL path from an A

    Definition Classes
    Urls
  27. 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
  28. 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
  29. 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
  30. 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 serverErrorResponseEntity: ResponseEntity[ServerError]
    Definition Classes
    Errors
  6. abstract def serverErrorToThrowable(serverError: ServerError): Throwable
    Definition Classes
    Errors
  7. abstract def stringCodec[A](implicit arg0: JsonCodec[A]): Codec[String, A]
    Definition Classes
    JsonEntitiesFromCodecs
  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 BadRequest: Int
    Definition Classes
    StatusCodes → StatusCodes
  6. def Created: Int
    Definition Classes
    StatusCodes → StatusCodes
  7. def Delete: String
    Definition Classes
    Methods → Methods
  8. def Forbidden: Int
    Definition Classes
    StatusCodes → StatusCodes
  9. def Get: String
    Definition Classes
    Methods → Methods
  10. def InternalServerError: Int
    Definition Classes
    StatusCodes → StatusCodes
  11. def NoContent: Int
    Definition Classes
    StatusCodes → StatusCodes
  12. def NotFound: Int
    Definition Classes
    StatusCodes → StatusCodes
  13. def NotImplemented: Int
    Definition Classes
    StatusCodes → StatusCodes
  14. def OK: Int
    Definition Classes
    StatusCodes → StatusCodes
  15. def Options: String
    Definition Classes
    Methods → Methods
  16. def Patch: String
    Definition Classes
    Methods → Methods
  17. def PayloadTooLarge: Int
    Definition Classes
    StatusCodes → StatusCodes
  18. def Post: String
    Definition Classes
    Methods → Methods
  19. def Put: String
    Definition Classes
    Methods → Methods
  20. def TooManyRequests: Int
    Definition Classes
    StatusCodes → StatusCodes
  21. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  22. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  23. final def badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
    Definition Classes
    Responses
  24. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  25. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  26. def choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  27. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  28. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  29. def clone(): AnyRef
    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native() @HotSpotIntrinsicCandidate()
  30. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  31. 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
  32. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  33. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  34. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  35. 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
  36. def emptyResponse: ResponseEntity[Unit]

    Discards response entity

    Discards response entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  37. def emptyResponseHeaders: ResponseHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  38. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  39. def equals(arg0: Any): Boolean
    Definition Classes
    AnyRef → Any
  40. 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
  41. final def getClass(): Class[_]
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  42. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  43. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  44. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  45. final def internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
    Definition Classes
    Responses
  46. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  47. def jsonRequest[A](implicit codec: JsonCodec[A]): RequestEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  48. def jsonResponse[A](implicit codec: JsonCodec[A]): ResponseEntity[A]
    Definition Classes
    JsonEntitiesFromCodecs → JsonEntities
  49. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  50. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  51. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  52. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  53. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native() @HotSpotIntrinsicCandidate()
  54. 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
  55. def optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  56. def optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  57. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  58. 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
  59. val path: Path[Unit]
    Definition Classes
    Urls
  60. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  61. 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
  62. 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
  63. 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
  64. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  65. implicit lazy val queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  66. implicit lazy val queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  67. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  68. 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
  69. 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
  70. implicit lazy val requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  71. def requestHeader(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  72. implicit lazy val requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  73. implicit lazy val requestHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  74. implicit def requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  75. 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
  76. implicit def responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  77. def responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  78. implicit def responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  79. implicit def responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  80. implicit lazy val responseInvariantFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  81. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  82. implicit lazy val segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  83. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  84. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  85. def stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  86. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  87. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  88. final def synchronized[T0](arg0: ⇒ T0): T0
    Definition Classes
    AnyRef
  89. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  90. def textResponse: ResponseEntity[String]

    Decodes a text entity

    Decodes a text entity

    Definition Classes
    EndpointsWithCustomErrors → Responses
  91. def toString(): String
    Definition Classes
    AnyRef → Any
  92. implicit lazy val urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  93. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  94. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  95. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  96. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  97. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... ) @native()
  98. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  99. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses
  100. 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
    Deprecated

    (Since version ) see corresponding Javadoc for more information.

Inherited from algebra.JsonEntitiesFromCodecs

Inherited from JsonCodecs

Inherited from JsonEntities

Inherited from EndpointsWithCustomErrors

Inherited from StatusCodes

Inherited from Methods

Inherited from Urls

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