Class AsyncArgdownApplication

Hierarchy

ArgdownApplication
- AsyncArgdownApplication

Index

Constructors

Properties

defaultLogger defaultProcesses logger processors

Methods

addPlugin getPlugin getPlugins load loadConfig removePlugin removeProcessor replacePlugin run runAsync

Constructors

constructor

new AsyncArgdownApplication(logger?: IArgdownLogger): AsyncArgdownApplication
Parameters
- Optionallogger: IArgdownLogger
Returns AsyncArgdownApplication
Inherited from ArgdownApplication.constructor
- Defined in argdown-core/dist/ArgdownApplication.d.ts:18

Properties

defaultLogger

defaultLogger: IArgdownLogger

defaultProcesses

defaultProcesses: { [name: string]: string[] }

logger

logger: IArgdownLogger

processors

processors: { [name: string]: IArgdownProcessor }

Methods

addPlugin

addPlugin(plugin: IArgdownPlugin, processorId?: string): void
Parameters
- plugin: IArgdownPlugin
- OptionalprocessorId: string
Returns void
Inherited from ArgdownApplication.addPlugin
- Defined in argdown-core/dist/ArgdownApplication.d.ts:19

getPlugin

getPlugin(name: string, processorId: string): IArgdownPlugin | null
Parameters
- name: string
- processorId: string
Returns IArgdownPlugin | null
Inherited from ArgdownApplication.getPlugin
- Defined in argdown-core/dist/ArgdownApplication.d.ts:23

getPlugins

getPlugins(processorId: string): IArgdownPlugin[] | null
Parameters
- processorId: string
Returns IArgdownPlugin[] | null
Inherited from ArgdownApplication.getPlugins
- Defined in argdown-core/dist/ArgdownApplication.d.ts:22

load

load(request: IArgdownRequest): Promise<IArgdownResponse[] | undefined>
Parameters
- request: IArgdownRequest
Returns Promise<IArgdownResponse[] | undefined>
- Defined in argdown-node/src/AsyncArgdownApplication.ts:170

loadConfig

loadConfig(filePath?: string): Promise<IArgdownRequest>
Parameters
- OptionalfilePath: string
Returns Promise<IArgdownRequest>
- Defined in argdown-node/src/AsyncArgdownApplication.ts:270

removePlugin

removePlugin(plugin: IArgdownPlugin, processorId?: string): void
Parameters
- plugin: IArgdownPlugin
- OptionalprocessorId: string
Returns void
Inherited from ArgdownApplication.removePlugin
- Defined in argdown-core/dist/ArgdownApplication.d.ts:20

removeProcessor

removeProcessor(processorId: string): void
Parameters
- processorId: string
Returns void
Inherited from ArgdownApplication.removeProcessor
- Defined in argdown-core/dist/ArgdownApplication.d.ts:24

replacePlugin

replacePlugin(
    oldPluginId: string,
    newPlugin: IArgdownPlugin,
    processorId?: string,
): void
Parameters
- oldPluginId: string
- newPlugin: IArgdownPlugin
- OptionalprocessorId: string
Returns void
Inherited from ArgdownApplication.replacePlugin
- Defined in argdown-core/dist/ArgdownApplication.d.ts:21

run

run(request: IArgdownRequest, response?: IArgdownResponse): IArgdownResponse
Parameters
- request: IArgdownRequest
- Optionalresponse: IArgdownResponse
Returns IArgdownResponse
Inherited from ArgdownApplication.run
- Defined in argdown-core/dist/ArgdownApplication.d.ts:25

runAsync

runAsync(
request: IArgdownRequest,
response?: IArgdownResponse,
): Promise<IArgdownResponse>
Parameters
- request: IArgdownRequest
- Optionalresponse: IArgdownResponse
Returns Promise<IArgdownResponse>
- Defined in argdown-node/src/AsyncArgdownApplication.ts:26