Type Members
-
abstract
class
Endpoint[A, B] extends AnyRef
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
-
type
JsonRequest[A] = Encoder[A]
-
type
JsonResponse[A] = Decoder[A]
-
type
Method = String
-
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]]
-
abstract
type
Result[A]
-
trait
Segment[A] extends AnyRef
-
implicit
class
SemigroupalSyntax[A, F[_]] extends AnyRef
-
trait
Url[A] extends AnyRef
Abstract Value Members
-
abstract
def
endpoint[A, B](request: Request[A], response: Response[B], summary: Documentation, description: Documentation, tags: List[String]): Endpoint[A, B]
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
-
final
def
##(): Int
-
final
def
==(arg0: Any): Boolean
-
def
Delete: String
-
def
Get: String
-
def
Options: String
-
def
Patch: String
-
def
Post: String
-
def
Put: String
-
final
def
asInstanceOf[T0]: T0
-
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]
-
implicit
def
dummyPathToUrl[A](p: Path[A]): Url[A]
-
-
-
def
emptyResponse(docs: Documentation): Response[Unit]
-
final
def
eq(arg0: AnyRef): Boolean
-
def
equals(arg0: Any): Boolean
-
def
finalize(): Unit
-
final
def
get[UrlP, HeadersP](url: Url[UrlP], headers: RequestHeaders[HeadersP])(implicit tuplerAC: Tupler[UrlP, HeadersP]): Request[Out]
-
final
def
getClass(): Class[_]
-
def
hashCode(): Int
-
def
header(name: String, docs: Documentation): RequestHeaders[String]
-
-
implicit
lazy val
intSegment: Segment[Int]
-
final
def
isInstanceOf[T0]: Boolean
-
def
jsonRequest[A](docs: Documentation)(implicit arg0: JsonRequest[A]): RequestEntity[A]
-
def
jsonResponse[A](docs: Documentation)(implicit decoder: Decoder[A]): Response[A]
-
-
implicit
lazy val
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]]
-
def
optQs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]
-
def
option[A](response: Function1[XMLHttpRequest, Either[Exception, A]], notFoundDocs: Documentation): Function1[XMLHttpRequest, Either[Exception, Option[A]]]
-
-
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](url: Url[UrlP], entity: RequestEntity[BodyP], headers: RequestHeaders[HeadersP])(implicit tuplerAB: Tupler.Aux[UrlP, BodyP, UrlAndBodyPTupled], tuplerABC: Tupler[UrlAndBodyPTupled, HeadersP]): Request[Out]
-
def
qs[A](name: String, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[A]
-
-
-
-
def
request[A, B, C, AB](method: Method, url: Url[A], entity: RequestEntity[B], headers: RequestHeaders[C])(implicit tuplerAB: Tupler.Aux[A, B, AB], tuplerABC: Tupler[AB, C]): Request[Out]
-
def
segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
-
def
staticPathSegment(segment: String): Path[Unit] with Serializable
-
implicit
lazy val
stringQueryString: QueryStringParam[String]
-
implicit
lazy val
stringSegment: Segment[String]
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
-
def
textRequest(docs: Documentation): RequestEntity[String]
-
def
textResponse(docs: Documentation): Response[String]
-
def
toString(): String
-
-
def
urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
-
final
def
wait(): Unit
-
final
def
wait(arg0: Long, arg1: Int): Unit
-
final
def
wait(arg0: Long): Unit
Inherited from AnyRef
Inherited from Any
An interpreter for algebra.JsonEntities that uses circe’s io.circe.Encoder to build JSON entities in HTTP requests, and circe’s io.circe.Decoder to decode JSON entities from HTTP responses.