ktor-server-core/io.ktor.server.http.content/SPAConfig

SPAConfig

class SPAConfig(var defaultPage: String = "index.html", var applicationRoute: String = "/", var filesPath: String = "", var useResources: Boolean = false, ignoredFiles: MutableList<(String) -> Boolean> = mutableListOf())

Configuration for the Routing.singlePageApplication plugin.

Constructors

SPAConfig

constructor(defaultPage: String = "index.html", applicationRoute: String = "/", filesPath: String = "", useResources: Boolean = false, ignoredFiles: MutableList<(String) -> Boolean> = mutableListOf())

Properties

applicationRoute

var applicationRoute: String

The URL path under which the content should be served

defaultPage

var defaultPage: String

The default name of a file or resource to serve when path inside applicationRoute is requested

filesPath

var filesPath: String

The path under which the static content is located. Corresponds to the folder path if the useResources is false, a resource path otherwise

useResources

var useResources: Boolean

Specifies if static content is a resource package with true or folder with false

Functions

angular

fun SPAConfig.angular(filesPath: String)

Creates an application configuration for the Angular project. Resources will be shared from the filesPath directory. The root file is index.html

backbone

fun SPAConfig.backbone(filesPath: String)

Creates an application configuration for the Backbone project. Resources will be shared from the filesPath directory. The root file is index.html

ember

fun SPAConfig.ember(filesPath: String)

Creates an application configuration for the Ember project. Resources will be shared from the filesPath directory. The root file is index.html

ignoreFiles

fun SPAConfig.ignoreFiles(block: (path: String) -> Boolean)

Registers a block in ignoredFiles returns true if path should be ignored.

react

fun SPAConfig.react(filesPath: String)

Creates an application configuration for the React project. Resources will be shared from the filesPath directory. The root file is index.html

vue

fun SPAConfig.vue(filesPath: String)

Creates an application configuration for the Vue project. Resources will be shared from the filesPath directory. The root file is index.html