Class IncludePlugin

Hierarchy

IncludePlugin

Implements

IAsyncArgdownPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new IncludePlugin(config?: IIncludeSettings): IncludePlugin

- Defined in argdown-node/src/plugins/IncludePlugin.ts:32
Parameters
- Optional config: IIncludeSettings
Returns IncludePlugin

Properties

defaults

defaults: IIncludeSettings

name

name: string = "IncludePlugin"

prepare

prepare: IRequestHandler = ...

runAsync

runAsync: IAsyncRequestHandler = ...

Methods

getSettings

getSettings(request: IArgdownRequest): IIncludeSettings

- Defined in argdown-node/src/plugins/IncludePlugin.ts:37
Parameters
- request: IArgdownRequest
Returns IIncludeSettings

replaceIncludesAsync

replaceIncludesAsync(currentFilePath: string, str: string, regEx: RegExp, filesAlreadyIncluded: string[]): Promise<string>

- Defined in argdown-node/src/plugins/IncludePlugin.ts:68
Parameters
- currentFilePath: string
- str: string
- regEx: RegExp
- filesAlreadyIncluded: string[]
Returns Promise<string>

Generated using TypeDoc