Class SaveAsFilePlugin

Hierarchy

SaveAsFilePlugin

Implements

IAsyncArgdownPlugin

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new SaveAsFilePlugin(config: ISaveAsSettings): SaveAsFilePlugin

- Defined in argdown-node/src/plugins/SaveAsFilePlugin.ts:44
Parameters
- config: ISaveAsSettings
Returns SaveAsFilePlugin

Properties

defaults

defaults: ISaveAsSettings

name

name: string = "SaveAsFilePlugin"

runAsync

runAsync: IAsyncRequestHandler = ...

Methods

getFileName

getFileName(file: string): string

- Defined in argdown-node/src/plugins/SaveAsFilePlugin.ts:128
Parameters
- file: string
Returns string

getSettings

getSettings(request: IArgdownRequest): ISaveAsSettings

- Defined in argdown-node/src/plugins/SaveAsFilePlugin.ts:54
Parameters
- request: IArgdownRequest
Returns ISaveAsSettings

saveAsFile

saveAsFile(data: string | Buffer, outputDir: string, fileName: string, extension: string, logger: IArgdownLogger): Promise<any>

- Defined in argdown-node/src/plugins/SaveAsFilePlugin.ts:132
Parameters
- data: string | Buffer
- outputDir: string
- fileName: string
- extension: string
- logger: IArgdownLogger
Returns Promise<any>

Generated using TypeDoc