xhr-client/endpoints4s.xhr/Urls

Urls

trait Urls extends Urls

algebra.Urls interpreter that builds URLs (in a JavaScript runtime environment).

trait Urls
class Object
trait Matchable
class Any
trait Assets
trait Endpoints
trait Endpoints
trait Endpoints

Type members

Classlikes

trait Path[A] extends Url[A]

Builds an URL path from an A

Builds an URL path from an A

trait QueryString[A]

Defines how to build a query string from an A

Defines how to build a query string from an A

trait QueryStringParam[A]

Defines how to build a query string parameter value from an A

Defines how to build a query string parameter value from an A

trait Segment[A]

Defines how to build a path segment from an A

Defines how to build a path segment from an A

trait Url[A]

Builds an URL from an A

Builds an URL from an A

Inherited classlikes

implicit class InvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: InvariantFunctor[F])

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Inherited from:
InvariantFunctorSyntax
implicit class PartialInvariantFunctorSyntax[A, F[_]](val fa: F[A])(implicit ev: PartialInvariantFunctor[F])
implicit class PathOps[A](first: Path[A])

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
implicit class QueryStringSyntax[A](first: QueryString[A])

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls

Types

type WithDefault[A] = Option[A]

Value members

Concrete methods

def chainPaths[A, B](first: Path[A], second: Path[B])(implicit tupler: Tupler[A, B]): Path[Out]
def combineQueryStrings[A, B](first: QueryString[A], second: QueryString[B])(implicit tupler: Tupler[A, B]): QueryString[Out]
override def optQsWithDefault[A](name: String, default: A, docs: Documentation)(implicit value: QueryStringParam[A]): QueryString[Option[A]]
Definition Classes
def qs[A](name: String, docs: Documentation)(implicit param: QueryStringParam[A]): QueryString[A]
def segment[A](name: String, docs: Documentation)(implicit s: Segment[A]): Path[A]
def urlWithQueryString[A, B](path: Path[A], qs: QueryString[B])(implicit tupler: Tupler[A, B]): Url[Out]

Inherited fields

val path: Path[Unit]

An empty path.

An empty path.

Useful to begin a path definition:

 path / "foo" / segment[Int] /? qs[String]("bar")
Inherited from:
Urls

Implicits

Implicits

implicit def optionalQueryStringParam[A](implicit param: QueryStringParam[A]): QueryStringParam[Option[A]]
implicit def repeatedQueryStringParam[A, CC <: (Iterable)](implicit param: QueryStringParam[A], factory: Factory[A, CC[A]]): QueryStringParam[CC[A]]
implicit lazy val stringSegment: Segment[String]

Inherited implicits

final implicit def InvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: InvariantFunctor[F]): InvariantFunctorSyntax[A, F]

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Extension methods for values of type F[A] for which there is an implicit InvariantFunctor[F] instance.

Inherited from:
InvariantFunctorSyntax
final implicit def PartialInvariantFunctorSyntax[A, F[_]](fa: F[A])(implicit ev: PartialInvariantFunctor[F]): PartialInvariantFunctorSyntax[A, F]
final implicit def PathOps[A](first: Path[A]): PathOps[A]

Convenient methods for Paths.

Convenient methods for Paths.

Inherited from:
Urls
final implicit def QueryStringSyntax[A](first: QueryString[A]): QueryStringSyntax[A]

Extension methods on QueryString.

Extension methods on QueryString.

Inherited from:
Urls
implicit def booleanQueryString: QueryStringParam[Boolean]

Query string parameter containing a Boolean value

Query string parameter containing a Boolean value

Inherited from:
Urls
implicit def doubleQueryString: QueryStringParam[Double]

Codec for query string parameters of type Double

Codec for query string parameters of type Double

Inherited from:
Urls
implicit def doubleSegment: Segment[Double]

Path segment codec for type Double

Path segment codec for type Double

Inherited from:
Urls
implicit def intQueryString: QueryStringParam[Int]

Ability to define Int query string parameters

Ability to define Int query string parameters

Inherited from:
Urls
implicit def intSegment: Segment[Int]

Path segment codec for type Int

Path segment codec for type Int

Inherited from:
Urls
implicit def longQueryString: QueryStringParam[Long]

Query string parameter containing a Long value

Query string parameter containing a Long value

Inherited from:
Urls
implicit def longSegment: Segment[Long]

Path segment codec for type Long

Path segment codec for type Long

Inherited from:
Urls
implicit def uuidQueryString: QueryStringParam[UUID]

Ability to define UUID query string parameters

Ability to define UUID query string parameters

Inherited from:
Urls
implicit def uuidSegment: Segment[UUID]

Path segment codec for type UUID

Path segment codec for type UUID

Inherited from:
Urls