Class TreeToFileConverter

A converter to convert a socko-api SockoNodeInterface tree into a file tree

Hierarchy

TreeToFileConverter

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new TreeToFileConverter(options: ConverterOptionsInterface): TreeToFileConverter

- Defined in lib/converter/TreeToFileConverter.ts:15
Build the converter with the given options

Parameters
- options: ConverterOptionsInterface
  
  the converter options to use
Returns TreeToFileConverter

Properties

Private _log

_log: Logger

Private _options

_options: ConverterOptionsInterface

Methods

Private _convert

_convert(node: SockoNodeInterface): Bluebird<void>

- Defined in lib/converter/TreeToFileConverter.ts:41
The recursive converter method

Parameters
- node: SockoNodeInterface
  
  the current node to convert
Returns Bluebird<void>

Private _processDirectory

_processDirectory(node: SockoNodeInterface, nodePath: string): Bluebird<void>

- Defined in lib/converter/TreeToFileConverter.ts:80
Convert a socko-api BranchNodeInterface into a directory

Parameters
- node: SockoNodeInterface
  
  current BranchNodeInterface node to process
- nodePath: string
  
  output path to use
Returns Bluebird<void>

Private _processFile

_processFile(node: SockoNodeInterface, nodePath: string): Bluebird<void>

- Defined in lib/converter/TreeToFileConverter.ts:114
Convert a socko-api OutputNodeInterface into a file

Parameters
- node: SockoNodeInterface
  
  node to process
- nodePath: string
  
  output path to use
Returns Bluebird<void>

convert

convert(root: RootNodeInterface): Bluebird<void>

- Defined in lib/converter/TreeToFileConverter.ts:31
Dump the given socko-api RootNodeInterface as a file tree

Parameters
- root: RootNodeInterface
Returns Bluebird<void>

Generated using TypeDoc