Skip to main content

ResourceServiceParameters

@webda/core

Class: ResourceServiceParameters

Defined in: packages/core/src/services/resource.service.ts:13

ResourceService parameters

Extends​

Constructors​

Constructor​

new ResourceServiceParameters(params?): ResourceServiceParameters

Defined in: packages/core/src/services/resource.service.ts:68

Create a new ResourceServiceParameters

Parameters​

params?​

any

the raw parameters

Returns​

ResourceServiceParameters

Overrides​

ServiceParameters.constructor

Properties​

allowHiddenFiles?​

optional allowHiddenFiles?: boolean

Defined in: packages/core/src/services/resource.service.ts:63

Serve also . prefixed files . files usually have some secrets and should not be served

Default​

false

cacheControl?​

optional cacheControl?: string

Defined in: packages/core/src/services/resource.service.ts:49

Cache control header to set

Default​

"public, max-age=31536000"

folder?​

optional folder?: string

Defined in: packages/core/src/services/resource.service.ts:25

Folder to server

Default​

"." + url

index?​

optional index?: string

Defined in: packages/core/src/services/resource.service.ts:37

Index file

Default​

index.html

indexCacheControl?​

optional indexCacheControl?: string

Defined in: packages/core/src/services/resource.service.ts:56

Cache control for index file SPA usually do not cache the index file

Default​

"no-cache, no-store, must-revalidate"

indexFallback?​

optional indexFallback?: boolean

Defined in: packages/core/src/services/resource.service.ts:44

Return the index file for any unfound resource Useful for single page application

Default​

true

rootRedirect?​

optional rootRedirect?: boolean

Defined in: packages/core/src/services/resource.service.ts:31

Add the / root to redirect to /{url}

Default​

false

type​

type: string

Defined in: packages/core/src/services/serviceparameters.ts:10

Type of the service

Inherited from​

ServiceParameters.type

url?​

optional url?: string

Defined in: packages/core/src/services/resource.service.ts:19

URL on which to serve the content

Default​

"resources"

Methods​

load()​

load(params?): this

Defined in: packages/core/src/services/resource.service.ts:82

Load parameters, applying defaults and normalizing url and folder. The application builds parameters as new Parameters().load(config), so this has to happen here rather than in the constructor.

Parameters​

params?​

any = {}

the raw parameters

Returns​

this

this for chaining

Overrides​

ServiceParameters.load

update()​

update(params?, delta): this

Defined in: packages/core/src/services/serviceparameters.ts:35

Update parameters and call watchers if a parameter was changed

Parameters​

params?​

any = {}

the service parameters

delta​

any

the delta

Returns​

this

this for chaining

Inherited from​

ServiceParameters.update

with()​

with(callback): this

Defined in: packages/core/src/services/serviceparameters.ts:65

Watch for changes on the parameters and call watchers when a parameter is changed

Parameters​

callback​

(params) => void

the callback function

Returns​

this

this for chaining

Inherited from​

ServiceParameters.with