ResourceService
Class: ResourceService<T>
This service expose a folder as web
It is the same as static on express
Webda Modda
Extends
Service<T>
Type parameters
• T extends ResourceServiceParameters = ResourceServiceParameters
Constructors
new ResourceService(webda, name, params)
new ResourceService<
T>(webda,name,params):ResourceService<T>
Service
Parameters
• webda: Core<CoreEvents>
The main instance of Webda
• name: string
The name of the service
• params: DeepPartial<T>= {}
The parameters block define in the configuration file
Returns
Inherited from
Source
packages/core/src/services/service.ts:334
Properties
_createException
_createException:
string
Inherited from
Source
packages/core/src/services/service.ts:315
_initException
_initException:
any=undefined
Inherited from
Source
packages/core/src/services/service.ts:317
_initTime
_initTime:
number
Inherited from
Source
packages/core/src/services/service.ts:316
_name
protected_name:string
Service name
Inherited from
Source
packages/core/src/services/service.ts:308
_resolved
_resolved:
string
Resolved path to the folder to serve
Source
packages/core/src/services/resource.ts:77
_webda
protected_webda:Core<CoreEvents>
Webda Core object
Inherited from
Source
packages/core/src/services/service.ts:304
fileOnly
fileOnly:
boolean
If serving just one file
Source
packages/core/src/services/resource.ts:81
logger
protectedlogger:Logger
Logger with class context
Inherited from
Source
packages/core/src/services/service.ts:321
metrics?
protectedmetrics?:any
Get metrics
Inherited from
Source
packages/core/src/services/service.ts:325
parameters
protectedparameters:T
Hold the parameters for your service
It will be bring from the webda.config.json
Inherited from
Source
packages/core/src/services/service.ts:314
captureRejectionSymbol
staticreadonlycaptureRejectionSymbol: typeofcaptureRejectionSymbol
Inherited from
Service.captureRejectionSymbol
Source
packages/core/node_modules/@types/node/events.d.ts:328
captureRejections
staticcaptureRejections:boolean
Sets or gets the default captureRejection value for all emitters.
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:333
defaultMaxListeners
staticdefaultMaxListeners:number
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:334
errorMonitor
staticreadonlyerrorMonitor: typeoferrorMonitor
This symbol shall be used to install a listener for only monitoring 'error'
events. Listeners installed using this symbol are called before the regular
'error' listeners are called.
Installing a listener using this symbol does not change the behavior once an
'error' event is emitted, therefore the process will still crash if no
regular 'error' listener is installed.
Inherited from
Source
packages/core/node_modules/@types/node/events.d.ts:327
Methods
__clean()
__clean():
Promise<void>
Clean the service data, can only be used in test mode
Returns
Promise<void>
Inherited from
Abstract
Source
packages/core/src/services/service.ts:642
_redirect()
_redirect(
ctx):void
Handle / request and redirect to the resources folder
Parameters
• ctx: WebContext<any, any>
Returns
void
Source
packages/core/src/services/resource.ts:166
_serve()
_serve(
ctx):Promise<unknown>
Serve the folder by itself, doing the mime detection
Parameters
• ctx: WebContext<any, any>
Returns
Promise<unknown>
Source
packages/core/src/services/resource.ts:175
addListener()
addListener(
eventName,listener):this
Alias for emitter.on(eventName, listener).
Parameters
• eventName: string | symbol
• listener: (...args) => void
Returns
this
Inherited from
Since
v0.1.26
Source
packages/core/node_modules/@types/node/events.d.ts:354
addRoute()
protectedaddRoute(url,methods,executer,openapi,override):void
Add a route dynamicaly
Parameters
• url: string
of the route can contains dynamic part like {uuid}
• methods: HttpMethodType[]
• executer: Function
Method to execute for this route
• openapi: OpenAPIWebdaDefinition= {}
• override: boolean= false
Returns
void
Inherited from
Source
packages/core/src/services/service.ts:482
authorizeClientEvent()
authorizeClientEvent(
_event,_context):boolean
Authorize a public event subscription
Parameters
• _event: string
• _context: OperationContext<any, any>
Returns
boolean
Inherited from
Source
packages/core/src/services/service.ts:438
computeParameters()
computeParameters():
void
Resolve resource folder
Returns
void