tapir-core
API
Generated with
tapir-core/sttp.tapir/sttp.tapir.static/ResourcesOptions

ResourcesOptions

sttp.tapir.static.ResourcesOptions
See theResourcesOptions companion object
case class ResourcesOptions[F[_]](useETags: Boolean, useGzippedIfAvailable: Boolean, resourceFilter: List[String] => Boolean, defaultResource: Option[List[String]])

Value parameters

defaultResource

path segments (relative to the resource prefix from which resources are read) of the resource to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application resource needs to be returned regardless of the path.

resourceFilter

A resource will be exposed only if this function returns true.

Attributes

Companion
object
Deprecated
[Since version 1.3.0]
Graph
Supertypes
trait Serializable
trait Product
trait Equals
class Object
trait Matchable
class Any
Show all

Members list

Value members

Concrete methods

def defaultResource(d: List[String]): ResourcesOptions[F]

Path segments (relative to the resource prefix from which resources are read) of the resource to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application resource needs to be returned regardless of the path.

Path segments (relative to the resource prefix from which resources are read) of the resource to return in case the one requested by the user isn't found. This is useful for SPA apps, where the same main application resource needs to be returned regardless of the path.

Attributes

def resourceFilter(f: List[String] => Boolean): ResourcesOptions[F]

A resource will be exposed only if this function returns true.

A resource will be exposed only if this function returns true.

Attributes

Inherited methods

def productElementNames: Iterator[String]

Attributes

Inherited from:
Product
def productIterator: Iterator[Any]

Attributes

Inherited from:
Product
Generated with