Skip to content

Latest commit

 

History

History
134 lines (67 loc) · 3.44 KB

Firedoc.md

File metadata and controls

134 lines (67 loc) · 3.44 KB

firedoc 1.9.2

Fireball is the game engine for the future.

Firedoc Class

Defined in: lib/firedoc.js:19

Module: digesters Parent Module: firedoc

Firedoc main class

Index

Properties
  • filecount Boolean Holds the number of files that we are processing.
  • filemap Object Holder for the list of files we are processing.
  • dirmap Object Holder for the list of directories we are processing.
  • options Object Internal holder for configuration options.
Methods
  • walk Walks the paths and parses the directory contents
  • walkOne Walk one path
  • build Process the config, walk the file tree and write out the JSON data.

Details

Properties

filecount

Holds the number of files that we are processing.

meta description
Type Boolean
Defined lib/firedoc.js:31
filemap

Holder for the list of files we are processing.

meta description
Type Object
Defined lib/firedoc.js:38
dirmap

Holder for the list of directories we are processing.

meta description
Type Object
Defined lib/firedoc.js:45
options

Internal holder for configuration options.

meta description
Type Object
Defined lib/firedoc.js:53

Methods

walk

Walks the paths and parses the directory contents

meta description
Defined lib/firedoc.js:132
Parameters
walkOne

Walk one path

meta description
Defined lib/firedoc.js:154
Parameters
build

Process the config, walk the file tree and write out the JSON data.

meta description
Defined lib/firedoc.js:201
Parameters