trait EndpointsWithCustomErrors extends xhr.EndpointsWithCustomErrors
- Alphabetic
- By Inheritance
- EndpointsWithCustomErrors
- EndpointsWithCustomErrors
- StatusCodes
- Methods
- Urls
- EndpointsWithCustomErrors
- Errors
- Responses
- StatusCodes
- Requests
- SemigroupalSyntax
- Methods
- Urls
- PartialInvariantFunctorSyntax
- InvariantFunctorSyntax
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Type Members
-
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
-
trait
Request[A] extends AnyRef
A function that takes the information
Aand returns the data to create an XMLHttpRequest.A function that takes the information
Aand returns the data to create an XMLHttpRequest.- Definition Classes
- EndpointsWithCustomErrors
-
trait
Path[A] extends Url[A]
Builds an URL path from an
ABuilds an URL path from an
A- Definition Classes
- Urls
-
trait
QueryString[A] extends AnyRef
Defines how to build a query string from an
ADefines how to build a query string from an
A- Definition Classes
- Urls
-
trait
QueryStringParam[A] extends AnyRef
Defines how to build a query string parameter value from an
ADefines how to build a query string parameter value from an
A- Definition Classes
- Urls
-
trait
Segment[A] extends AnyRef
Defines how to build a path segment from an
ADefines how to build a path segment from an
A- Definition Classes
- Urls
-
trait
Url[A] extends AnyRef
Builds an URL from an
ABuilds an URL from an
A- Definition Classes
- Urls
-
final
class
CallbackDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
type
CallbacksDocs = Map[String, CallbackDocs]
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
type
ClientErrors
- Definition Classes
- Errors
-
final
class
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors
-
implicit final
class
EndpointSyntax[A, B] extends AnyRef
- Definition Classes
- EndpointsWithCustomErrors
-
implicit
class
InvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- InvariantFunctorSyntax
-
type
Method = String
- Definition Classes
- Methods → Methods
-
implicit
class
PartialInvariantFunctorSyntax[A, F[_]] extends AnyRef
- Definition Classes
- PartialInvariantFunctorSyntax
-
implicit
class
PathOps[A] extends AnyRef
- Definition Classes
- Urls
-
implicit
class
QueryStringSyntax[A] extends AnyRef
- Definition Classes
- Urls
-
type
RequestEntity[A] = Function2[A, XMLHttpRequest, Any]
A function that, given information
Aand an XMLHttpRequest, returns a request entity.A function that, given information
Aand 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
-
implicit
class
RequestEntitySyntax[A] extends AnyRef
- Definition Classes
- Requests
-
type
RequestHeaders[A] = Function2[A, XMLHttpRequest, Unit]
A function that takes the information
Aand the XMLHttpRequest and sets up some headers on it.A function that takes the information
Aand the XMLHttpRequest and sets up some headers on it.- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit final
class
RequestSyntax[A] extends AnyRef
- Definition Classes
- Requests
-
type
Response[A] = Function1[XMLHttpRequest, Option[ResponseEntity[A]]]
Attempts to decode an
Afrom an XMLHttpRequest’s responseAttempts to decode an
Afrom an XMLHttpRequest’s response- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseEntity[A] = Function1[XMLHttpRequest, Either[Throwable, A]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
type
ResponseHeaders[A] = (XMLHttpRequest) ⇒ Validated[A]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
class
ResponseSyntax[A] extends AnyRef
- Definition Classes
- Responses
-
abstract
class
Result[A] extends AnyRef
Maps
ResulttoFuture -
implicit
class
SemigroupalSyntax[A, F[_]] extends AnyRef
- Definition Classes
- SemigroupalSyntax
-
abstract
type
ServerError
- Definition Classes
- Errors
-
type
StatusCode = Int
- Definition Classes
- StatusCodes → StatusCodes
-
type
WithDefault[A] = Option[A]
- Definition Classes
- Urls → Urls
Abstract Value Members
-
abstract
def
clientErrorsResponseEntity: ResponseEntity[ClientErrors]
- Definition Classes
- Errors
-
abstract
def
clientErrorsToInvalid(clientErrors: ClientErrors): Invalid
- Definition Classes
- Errors
-
abstract
def
invalidToClientErrors(invalid: Invalid): ClientErrors
- Definition Classes
- Errors
-
abstract
def
serverErrorResponseEntity: ResponseEntity[ServerError]
- Definition Classes
- Errors
-
abstract
def
serverErrorToThrowable(serverError: ServerError): Throwable
- Definition Classes
- Errors
-
abstract
def
settings: EndpointsSettings
- Definition Classes
- EndpointsWithCustomErrors
-
abstract
def
throwableToServerError(throwable: Throwable): ServerError
- Definition Classes
- Errors
Concrete Value Members
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
Accepted: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
AlreadyReported: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
BadRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Conflict: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Created: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Delete: String
- Definition Classes
- Methods → Methods
-
def
ExpectationFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
FailedDependency: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Forbidden: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Get: String
- Definition Classes
- Methods → Methods
-
def
Gone: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
IMUsed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
InternalServerError: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
LengthRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Locked: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MethodNotAllowed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MisdirectedRequest: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
MultiStatus: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NoContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NonAuthoritativeInformation: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotAcceptable: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotFound: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotImplemented: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
NotModified: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
OK: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Options: String
- Definition Classes
- Methods → Methods
-
def
PartialContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Patch: String
- Definition Classes
- Methods → Methods
-
def
PayloadTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
PaymentRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
PermanentRedirect: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Post: String
- Definition Classes
- Methods → Methods
-
def
PreconditionFailed: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
PreconditionRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
ProxyAuthenticationRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Put: String
- Definition Classes
- Methods → Methods
-
def
RangeNotSatisfiable: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestHeaderFieldsTooLarge: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
RequestTimeout: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
ResetContent: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
TemporaryRedirect: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooEarly: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
TooManyRequests: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
Unauthorized: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnavailableForLegalReasons: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnprocessableEntity: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UnsupportedMediaType: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UpgradeRequired: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
UriTooLong: Int
- Definition Classes
- StatusCodes → StatusCodes
-
def
addRequestHeaders[A, H](request: Request[A], headers: RequestHeaders[H])(implicit tupler: Tupler[A, H]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
addRequestQueryString[A, Q](request: Request[A], qs: QueryString[Q])(implicit tupler: Tupler[A, Q]): Request[Out]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
addResponseHeaders[A, H](response: Response[A], headers: ResponseHeaders[H])(implicit tupler: Tupler[A, H]): Response[Out]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
final
def
badRequest[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ClientErrors, A, R]): Response[R]
- Definition Classes
- Responses
-
implicit
def
booleanQueryString: QueryStringParam[Boolean]
- Definition Classes
- Urls
-
def
chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
- Definition Classes
- Urls → Urls
-
def
choiceRequestEntity[A, B](requestEntityA: RequestEntity[A], requestEntityB: RequestEntity[B]): RequestEntity[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
choiceResponse[A, B](responseA: Response[A], responseB: Response[B]): Response[Either[A, B]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
lazy val
clientErrorsResponse: Response[ClientErrors]
- Definition Classes
- Errors
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native() @HotSpotIntrinsicCandidate()
-
def
combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
- Definition Classes
- Urls → Urls
-
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
-
implicit
def
doubleQueryString: QueryStringParam[Double]
- Definition Classes
- Urls
-
implicit
def
doubleSegment: Segment[Double]
- Definition Classes
- Urls
-
lazy val
emptyRequest: RequestEntity[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
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
-
def
emptyResponse: ResponseEntity[Unit]
Discards response entity
Discards response entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
emptyResponseHeaders: ResponseHeaders[Unit]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
endpoint[A, B](request: Request[A], response: Response[B], docs: EndpointDocs = EndpointDocs()): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
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
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
def
hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
implicit
def
intQueryString: QueryStringParam[Int]
- Definition Classes
- Urls
-
implicit
def
intSegment: Segment[Int]
- Definition Classes
- Urls
-
final
def
internalServerError[A, R](docs: Documentation, headers: ResponseHeaders[A])(implicit tupler: Tupler.Aux[ServerError, A, R]): Response[R]
- Definition Classes
- Responses
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
implicit
def
longQueryString: QueryStringParam[Long]
- Definition Classes
- Urls
-
implicit
def
longSegment: Segment[Long]
- Definition Classes
- Urls
-
def
mapEndpointDocs[A, B](currentEndpoint: Endpoint[A, B], func: (EndpointDocs) ⇒ EndpointDocs): Endpoint[A, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
def
mapEndpointRequest[A, B, C](currentEndpoint: Endpoint[A, B], func: (Request[A]) ⇒ Request[C]): Endpoint[C, B]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
def
mapEndpointResponse[A, B, C](currentEndpoint: Endpoint[A, B], func: (Response[B]) ⇒ Response[C]): Endpoint[A, C]
- Definition Classes
- EndpointsWithCustomErrors → EndpointsWithCustomErrors → EndpointsWithCustomErrors
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native() @HotSpotIntrinsicCandidate()
-
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
-
def
optQsWithDefault[A](name: String, default: A, docs: Documentation = None)(implicit value: QueryStringParam[A]): QueryString[WithDefault[A]]
- Definition Classes
- Urls → Urls
-
def
optRequestHeader(name: String, docs: Documentation): RequestHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
optResponseHeader(name: String, docs: Documentation = None): ResponseHeaders[Option[String]]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
- Definition Classes
- Urls → Urls
-
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
-
val
path: Path[Unit]
- Definition Classes
- Urls
-
implicit
lazy val
pathPartialInvariantFunctor: PartialInvariantFunctor[Path]
- Definition Classes
- Urls → Urls
-
final
def
performXhr[A, B](request: Request[A], response: Response[B], a: A)(onload: (Either[Throwable, B]) ⇒ Unit, onerror: (Throwable) ⇒ Unit): Function0[Unit]
- Attributes
- protected
- Definition Classes
- EndpointsWithCustomErrors
-
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
-
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
-
def
qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
queryStringParamPartialInvariantFunctor: PartialInvariantFunctor[QueryStringParam]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
queryStringPartialInvariantFunctor: PartialInvariantFunctor[QueryString]
- Definition Classes
- Urls → Urls
-
def
remainingSegments(name: String, docs: Documentation): Path[String]
- Definition Classes
- Urls → Urls
-
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
-
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
-
implicit
lazy val
requestEntityPartialInvariantFunctor: PartialInvariantFunctor[RequestEntity]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
requestHeader(name: String, docs: Documentation): RequestHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
lazy val
requestHeadersPartialInvariantFunctor: PartialInvariantFunctor[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
lazy val
requestHeadersSemigroupal: Semigroupal[RequestHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
implicit
def
requestPartialInvariantFunctor: PartialInvariantFunctor[Request]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
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
-
implicit
def
responseEntityInvariantFunctor: InvariantFunctor[ResponseEntity]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
responseHeader(name: String, docs: Documentation = None): ResponseHeaders[String]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersInvariantFunctor: InvariantFunctor[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
def
responseHeadersSemigroupal: Semigroupal[ResponseHeaders]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
implicit
lazy val
responseInvariantFunctor: InvariantFunctor[Response]
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
segmentPartialInvariantFunctor: PartialInvariantFunctor[Segment]
- Definition Classes
- Urls → Urls
-
lazy val
serverErrorResponse: Response[ServerError]
- Definition Classes
- Errors
-
def
staticPathSegment(segment: String): Path[Unit]
- Definition Classes
- Urls → Urls
-
def
stringCodecResponse[A](implicit codec: Decoder[String, A]): ResponseEntity[A]
- Definition Classes
- EndpointsWithCustomErrors
-
implicit
lazy val
stringQueryString: QueryStringParam[String]
- Definition Classes
- Urls → Urls
-
implicit
lazy val
stringSegment: Segment[String]
- Definition Classes
- Urls → Urls
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
lazy val
textRequest: RequestEntity[String]
- Definition Classes
- EndpointsWithCustomErrors → Requests
-
def
textResponse: ResponseEntity[String]
Decodes a text entity
Decodes a text entity
- Definition Classes
- EndpointsWithCustomErrors → Responses
-
def
toString(): String
- Definition Classes
- AnyRef → Any
-
implicit
lazy val
urlPartialInvariantFunctor: PartialInvariantFunctor[Url]
- Definition Classes
- Urls → Urls
-
def
urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]
- Definition Classes
- Urls → Urls
-
implicit
def
uuidQueryString: QueryStringParam[UUID]
- Definition Classes
- Urls
-
implicit
def
uuidSegment: Segment[UUID]
- Definition Classes
- Urls
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wheneverFound[A](responseA: Response[A], notFoundDocs: Documentation): Response[Option[A]]
- Definition Classes
- Responses
-
object
EndpointDocs extends Serializable
- Definition Classes
- EndpointsWithCustomErrors