Skip to main content

ResourceServiceParameters

@webda/core • Readme | API

Class: ResourceServiceParameters

ResourceService parameters

Extends​

Constructors​

new ResourceServiceParameters(params)​

new ResourceServiceParameters(params): ResourceServiceParameters

Parameters​

• params: any

Returns​

ResourceServiceParameters

Overrides​

ServiceParameters.constructor

Source​

packages/core/src/services/resource.ts:44

Properties​

folder?​

folder?: string

Folder to server

Default​

"." + url

Source​

packages/core/src/services/resource.ts:23

index?​

index?: string

Index file

Default​

index.html

Source​

packages/core/src/services/resource.ts:35

indexFallback?​

indexFallback?: boolean

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

Default​

true

Source​

packages/core/src/services/resource.ts:42

openapi?​

openapi?: OpenAPIWebdaDefinition

OpenAPI override

Schema Ignore​

Inherited from​

ServiceParameters.openapi

Source​

packages/core/src/services/service.ts:260

rootRedirect?​

rootRedirect?: boolean

Add the / root to redirect to /{url}

Default​

false

Source​

packages/core/src/services/resource.ts:29

type​

type: string

Type of the service

Inherited from​

ServiceParameters.type

Source​

packages/core/src/services/service.ts:251

url?​

url?: string

URL on which to serve the content

Default​

"resources"

Overrides​

ServiceParameters.url

Source​

packages/core/src/services/resource.ts:17