Class FileSystemExchange

Hierarchy

AbstractExchange<FileSystemRequest, FileSystemResponse>
- FileSystemExchange

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new FileSystemExchange(): FileSystemExchange

Overrides AbstractExchange.constructor
- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:22
Returns FileSystemExchange

Properties

allowedPaths

allowedPaths: { match: boolean; path: string }[] = []

basePath

basePath: string

config

config: IFileSystemConfig = {}

logger

logger: ILoggerApi = ...

Readonly reqCls

reqCls: ClassType<FileSystemRequest>

Readonly resCls

resCls: ClassType<FileSystemResponse>

Methods

create

create(options?: IMessageOptions): Message<FileSystemRequest, FileSystemResponse>

Inherited from AbstractExchange.create
- Defined in src/libs/messaging/AbstractExchange.ts:59
Parameters
- options: IMessageOptions = {}
Returns Message<FileSystemRequest, FileSystemResponse>

file

file(opts: IFileOptions): Promise<any[]>

- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:59
Parameters
- opts: IFileOptions
Returns Promise<any[]>

getReqClass

getReqClass(): ClassType<FileSystemRequest>

Inherited from AbstractExchange.getReqClass
- Defined in src/libs/messaging/AbstractExchange.ts:49
Returns ClassType<FileSystemRequest>

getResClass

getResClass(): ClassType<FileSystemResponse>

Inherited from AbstractExchange.getResClass
- Defined in src/libs/messaging/AbstractExchange.ts:54
Returns ClassType<FileSystemResponse>

getResponse

getResponse(request: FileSystemRequest): Promise<FileSystemResponse>

Inherited from AbstractExchange.getResponse
- Defined in src/libs/messaging/AbstractExchange.ts:64
Parameters
- request: FileSystemRequest
Returns Promise<FileSystemResponse>

getSystem

getSystem(): System

Inherited from AbstractExchange.getSystem
- Defined in src/libs/messaging/AbstractExchange.ts:44
Returns System

handleRequest

handleRequest(request: FileSystemRequest, res: FileSystemResponse): Promise<void>

Overrides AbstractExchange.handleRequest
- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:121
Parameters
- request: FileSystemRequest
- res: FileSystemResponse
Returns Promise<void>

handleRequestList

handleRequestList(request: FileSystemRequest, res: FileSystemResponse): Promise<void>

- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:91
Parameters
- request: FileSystemRequest
- res: FileSystemResponse
Returns Promise<void>

handleRequestRead

handleRequestRead(request: FileSystemRequest, res: FileSystemResponse): Promise<void>

- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:66
Parameters
- request: FileSystemRequest
- res: FileSystemResponse
Returns Promise<void>

handleResponse

handleResponse(responses: FileSystemResponse): any

Overrides AbstractExchange.handleResponse
- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:165
Parameters
- responses: FileSystemResponse
Returns any

isActive

isActive(): boolean

Inherited from AbstractExchange.isActive
- Defined in src/libs/messaging/AbstractExchange.ts:39
Give possiblity to mark this exchange as disabled

Returns boolean

onRequest

onRequest(request: FileSystemRequest): Promise<any>

Inherited from AbstractExchange.onRequest
- Defined in src/libs/messaging/AbstractExchange.ts:78
Parameters
- request: FileSystemRequest
Returns Promise<any>

prepare

prepare(): Promise<void>

Overrides AbstractExchange.prepare
- Defined in src/adapters/exchange/filesystem/FileSystemExchange.ts:32
using onStartup to declare accessible system paths

Returns Promise<void>

Generated using TypeDoc