Packages

t

endpoints.xhr.circe

JsonEntities

trait JsonEntities extends EndpointsWithCustomErrors with algebra.JsonEntities

Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. JsonEntities
  2. JsonEntities
  3. EndpointsWithCustomErrors
  4. StatusCodes
  5. Methods
  6. Urls
  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. case class CallbackDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  2. type CallbacksDocs = Map[String, CallbackDocs]
    Definition Classes
    EndpointsWithCustomErrors
  3. abstract type ClientErrors
    Definition Classes
    Errors
  4. abstract class Endpoint[A, B] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  5. case class EndpointDocs extends Product with Serializable
    Definition Classes
    EndpointsWithCustomErrors
  6. implicit class InvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    InvariantFunctorSyntax
  7. type JsonRequest[A] = Encoder[A]

    Encode an A using circe’s io.circe.Encoder

    Encode an A using circe’s io.circe.Encoder

    Definition Classes
    JsonEntities → JsonEntities
  8. type JsonResponse[A] = Decoder[A]

    Decodes an A using circe’s io.circe.Decoder

    Decodes an A using circe’s io.circe.Decoder

    Definition Classes
    JsonEntities → JsonEntities
  9. type Method = String
    Definition Classes
    Methods → Methods
  10. implicit class PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
    Definition Classes
    PartialInvariantFunctorSyntax
  11. trait Path[A] extends Url[A]
    Definition Classes
    Urls
  12. implicit class PathOps[A] extends AnyRef
    Definition Classes
    Urls
  13. trait QueryString[A] extends AnyRef
    Definition Classes
    Urls
  14. trait QueryStringParam[A] extends AnyRef
    Definition Classes
    Urls
  15. implicit class QueryStringSyntax[A] extends AnyRef
    Definition Classes
    Urls
  16. trait Request[A] extends AnyRef
    Definition Classes
    EndpointsWithCustomErrors
  17. type RequestEntity[A] = Function2[A, XMLHttpRequest, Any]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  18. type RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  19. type Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  20. type ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  21. implicit class ResponseSyntax[A] extends AnyRef
    Definition Classes
    Responses
  22. abstract type Result[A]
    Definition Classes
    EndpointsWithCustomErrors
  23. trait Segment[A] extends AnyRef
    Definition Classes
    Urls
  24. implicit class SemigroupalSyntax[A, F[_]] extends AnyRef
    Definition Classes
    SemigroupalSyntax
  25. abstract type ServerError
    Definition Classes
    Errors
  26. type StatusCode = Int
    Definition Classes
    StatusCodes → StatusCodes
  27. trait Url[A] extends AnyRef
    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 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 Post: String
    Definition Classes
    Methods → Methods
  18. def Put: String
    Definition Classes
    Methods → Methods
  19. def Unauthorized: Int
    Definition Classes
    StatusCodes → StatusCodes
  20. final def asInstanceOf[T0]: T0
    Definition Classes
    Any
  21. final def badRequest(docs: Documentation): Response[ClientErrors]
    Definition Classes
    Responses
  22. implicit def booleanQueryString: QueryStringParam[Boolean]
    Definition Classes
    Urls
  23. def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
    Definition Classes
    Urls → Urls
  24. def choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  25. lazy val clientErrorsResponse: Response[ClientErrors]
    Definition Classes
    Errors
  26. def clone(): AnyRef
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.CloneNotSupportedException]) @native()
  27. def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
    Definition Classes
    Urls → Urls
  28. 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
  29. implicit def doubleQueryString: QueryStringParam[Double]
    Definition Classes
    Urls
  30. implicit def doubleSegment: Segment[Double]
    Definition Classes
    Urls
  31. implicit def dummyPathToUrl[A](p: Path[A]): Url[A]
    Definition Classes
    Urls
  32. lazy val emptyHeaders: RequestHeaders[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  33. lazy val emptyRequest: RequestEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  34. def emptyResponse: ResponseEntity[Unit]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  35. final def eq(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  36. def equals(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef → Any
  37. def finalize(): Unit
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.Throwable])
  38. 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
  39. final def getClass(): Class[_ <: AnyRef]
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  40. def hashCode(): Int
    Definition Classes
    AnyRef → Any
    Annotations
    @native()
  41. def header(name: String, docs: Documentation): RequestHeaders[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  42. implicit def intQueryString: QueryStringParam[Int]
    Definition Classes
    Urls
  43. implicit def intSegment: Segment[Int]
    Definition Classes
    Urls
  44. final def internalServerError(docs: Documentation): Response[ServerError]
    Definition Classes
    Responses
  45. final def isInstanceOf[T0]: Boolean
    Definition Classes
    Any
  46. def jsonRequest[A](implicit arg0: JsonRequest[A]): RequestEntity[A]
    Definition Classes
    JsonEntities → JsonEntities
  47. def jsonResponse[A](implicit decoder: Decoder[A]): ResponseEntity[A]
    Definition Classes
    JsonEntities → JsonEntities
  48. implicit def longQueryString: QueryStringParam[Long]
    Definition Classes
    Urls
  49. implicit def longSegment: Segment[Long]
    Definition Classes
    Urls
  50. final def ne(arg0: AnyRef): Boolean
    Definition Classes
    AnyRef
  51. final def notify(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  52. final def notifyAll(): Unit
    Definition Classes
    AnyRef
    Annotations
    @native()
  53. final def ok[A](entity: ResponseEntity[A], docs: Documentation): Response[A]
    Definition Classes
    Responses
  54. def optHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  55. implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
    Definition Classes
    Urls → Urls
  56. val path: Path[Unit]
    Definition Classes
    Urls
  57. implicit lazy val pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
    Definition Classes
    Urls → Urls
  58. 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
  59. 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
  60. 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
  61. def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
    Definition Classes
    Urls → Urls
  62. implicit lazy val queryStringParamPartialInvFunctor: PartialInvariantFunctor[QueryStringParam]
    Definition Classes
    Urls → Urls
  63. implicit lazy val queryStringPartialInvFunctor: PartialInvariantFunctor[QueryString]
    Definition Classes
    Urls → Urls
  64. def remainingSegments(name: String, docs: Documentation): Path[String]
    Definition Classes
    Urls → Urls
  65. implicit def repeatedQueryStringParam[A, CC[X] <: Iterable[X]](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
    Definition Classes
    Urls → Urls
  66. implicit lazy val reqEntityInvFunctor: InvariantFunctor[RequestEntity]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  67. implicit lazy val reqHeadersInvFunctor: InvariantFunctor[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  68. implicit lazy val reqHeadersSemigroupal: Semigroupal[RequestHeaders]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  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. def response[A](statusCode: StatusCode, entity: ResponseEntity[A], docs: Documentation): Response[A]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  71. implicit lazy val responseInvFunctor: InvariantFunctor[Response]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  72. def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
    Definition Classes
    Urls → Urls
  73. implicit lazy val segmentPartialInvFunctor: PartialInvariantFunctor[Segment]
    Definition Classes
    Urls → Urls
  74. lazy val serverErrorResponse: Response[ServerError]
    Definition Classes
    Errors
  75. def staticPathSegment(segment: String): Path[Unit]
    Definition Classes
    Urls → Urls
  76. def stringCodecResponse[A](implicit codec: Codec[String, A]): ResponseEntity[A]
    Definition Classes
    EndpointsWithCustomErrors
  77. implicit lazy val stringQueryString: QueryStringParam[String]
    Definition Classes
    Urls → Urls
  78. implicit lazy val stringSegment: Segment[String]
    Definition Classes
    Urls → Urls
  79. final def synchronized[T0](arg0: => T0): T0
    Definition Classes
    AnyRef
  80. lazy val textRequest: RequestEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Requests
  81. def textResponse: ResponseEntity[String]
    Definition Classes
    EndpointsWithCustomErrors → Responses
  82. def toString(): String
    Definition Classes
    AnyRef → Any
  83. def tryParseString[A](type: String)(parse: (String) => A): (String) => Validated[A]
    Definition Classes
    Urls
  84. implicit lazy val urlPartialInvFunctor: PartialInvariantFunctor[Url]
    Definition Classes
    Urls → Urls
  85. def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
    Definition Classes
    Urls → Urls
  86. implicit def uuidQueryString: QueryStringParam[UUID]
    Definition Classes
    Urls
  87. implicit def uuidSegment: Segment[UUID]
    Definition Classes
    Urls
  88. final def wait(): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  89. final def wait(arg0: Long, arg1: Int): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException])
  90. final def wait(arg0: Long): Unit
    Definition Classes
    AnyRef
    Annotations
    @throws(classOf[java.lang.InterruptedException]) @native()
  91. final def wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
    Definition Classes
    Responses

Inherited from algebra.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 endpoints.SemigroupalSyntax

Inherited from algebra.Methods

Inherited from algebra.Urls

Inherited from endpoints.PartialInvariantFunctorSyntax

Inherited from endpoints.InvariantFunctorSyntax

Inherited from AnyRef

Inherited from Any

Ungrouped