Class FileProvider

Represents a file provider for serving files.

Hierarchy

AuthableDecorableFunction
- FileProvider
  - ImageProvider

Index

Constructors

Properties

authenticator decoratorConfigReference isOutbound label objConfig

Accessors

Func hasAuthenticator

Methods

authenticateOrThrow bindDecoratorConfig loadDecoratorConfig sendError setAuthenticator

Constructors

constructor

new FileProvider(label, objConfig): FileProvider
Creates a new instance of the FileProvider class.
Parameters
- label: string
  
  The label of the file provider.
- objConfig: {
  propertyKey: string;
  target: any;
  }
  
  The configuration object containing the target and property key.
  - propertyKey: string
  - target: any
Returns FileProvider
Overrides AuthableDecorableFunction.constructor
- Defined in src/content/files/file-provider.ts:17

Properties

`Protected` authenticator

authenticator: WebsocketAuthenticator = null

`Private` decoratorConfigReference

decoratorConfigReference: ContentProviderDecoratorConfig

`Protected` isOutbound

isOutbound: boolean = false

label

label: string

The label of the file provider.

`Protected` objConfig

objConfig: {
propertyKey: string;
target: any;
}

The configuration object for the object method.

Type declaration

propertyKey: string
target: any

Accessors

Func

get Func(): ((...data) => any)
Returns the decorated function with added authentication checks.

Returns ((...data) => any)
- The decorated function.
- - (...data): any
  - Returns the decorated function with added authentication checks.
    Parameters
    - Rest ...data: any[]
    Returns any
    - The decorated function.
Inherited from AuthableDecorableFunction.Func
- Defined in src/decorator-config/function.ts:82

hasAuthenticator

get hasAuthenticator(): boolean
Checks if the decorated function has an authenticator.

Returns boolean
- Indicates whether the decorated function has an authenticator.
Inherited from AuthableDecorableFunction.hasAuthenticator
- Defined in src/decorator-config/function.ts:115

Methods

`Protected` authenticateOrThrow

authenticateOrThrow(conn, requestData?): Promise<void>
Parameters
- conn: WebsocketConnection
- Optional requestData: any
Returns Promise<void>
Inherited from AuthableDecorableFunction.authenticateOrThrow
- Defined in src/decorator-config/function.ts:101

bindDecoratorConfig

bindDecoratorConfig(reference): FileProvider
Binds the decorator configuration reference to the file provider.
Parameters
- reference: ContentProviderDecoratorConfig
  
  The decorator configuration reference.
Returns FileProvider
- The file provider instance.
- Defined in src/content/files/file-provider.ts:49

loadDecoratorConfig

loadDecoratorConfig(): void
Loads the decorator configuration from the bound reference.

Returns void
- Defined in src/content/files/file-provider.ts:57

`Protected` sendError

sendError(conn, message, authError?): void
Handles errors during the process
Parameters
- conn: WebsocketConnection
  
  empty (unused)
- message: string | AuthenticationError
  
  error message
- Optional authError: boolean
Returns void
Overrides AuthableDecorableFunction.sendError
- Defined in src/content/files/file-provider.ts:30

setAuthenticator

setAuthenticator(authenticator): void
Sets the authenticator for the decorated function.
Parameters
- authenticator: WebsocketAuthenticator
  
  The websocket authenticator.
Returns void
Inherited from AuthableDecorableFunction.setAuthenticator
- Defined in src/decorator-config/function.ts:74

Generated using TypeDoc