# Variable

Static Public Summary
public | ExitCodes: Map<string, number> System exit codes |
public | aliases: Map<string, string> Available command aliases |
public | availableCommandsList: string[] All available command names as list (includes aliases) |
public | commands: Map<string, string> Available command names |
public | commandsMap: Map<string, Function> Commands map |
public | config: Object mongoose-data-seed config |
public | configFilename: String mongoose-data-seed user config filename |
public | defaultCommand: string The fefault command name |
public | defaultUserGeneratorConfig: Object mongoose-data-seed default user generator-config |
public | optionDefinitions: Object[] Generate command option defenitions |
public | optionDefinitions: Object[] Init command option defenitions |
public | optionDefinitions: Object[] Run command option defenitions |
public | systemConfigTemplate: string system template for user-config path |
public | systemSeederTemplate: string system seeder template path |
public | usageGuide: string Help command user guide |
public | usageGuide: string Run command user guide |

## Static Public

### public ExitCodes: Map<string, number> source

    import {ExitCodes} from 'mongoose-data-seed/src/lib/utils/constants.js'

System exit codes

Map exit code key to exit code number

### public aliases: Map<string, string> source

    import {aliases} from 'mongoose-data-seed/src/lib/commands/constants.js'

Available command aliases

Map alias to command name

### public availableCommandsList: string[] source

    import {availableCommandsList} from 'mongoose-data-seed/src/lib/commands/constants.js'

All available command names as list (includes aliases)

### public commands: Map<string, string> source

    import {commands} from 'mongoose-data-seed/src/lib/commands/constants.js'

Available command names

Map command key to command name

### public commandsMap: Map<string, Function> source

    import {commandsMap} from 'mongoose-data-seed/src/lib/commands/constants.js'

Commands map

Map command name to the actuall command function

### public config: Object source

    import config from 'mongoose-data-seed/src/lib/config.js'

mongoose-data-seed config

#### Properties:

Name | Type | Attribute | Description
clean | Function |  |
getConfigFromPackageJson | Function |  |
getUserGeneratorConfig | Function |  |
update | Function |  |
loadUserConfig | Function |  |
projectRoot | String |  |
userConfigFilename | String |  |
userConfigFilepath | String |  |
userSeedersFolderName | String |  |
userSeedersFolderPath | String |  |
userConfigExists | boolean |  |
seederTemplate | String |  |
configTemplate | String |  |

### public configFilename: String source

    import {configFilename} from 'mongoose-data-seed/src/lib/constants.js'

mongoose-data-seed user config filename

### public defaultCommand: string source

    import {defaultCommand} from 'mongoose-data-seed/src/lib/commands/constants.js'

The fefault command name

### public defaultUserGeneratorConfig: Object source

    import {defaultUserGeneratorConfig} from 'mongoose-data-seed/src/lib/constants.js'

mongoose-data-seed default user generator-config

#### Properties:

Name | Type | Attribute | Description
seedersFolder | string |  |

### public optionDefinitions: Object[] source

    import optionDefinitions from 'mongoose-data-seed/src/lib/commands/generate/option-definitions.js'

Generate command option defenitions

### public optionDefinitions: Object[] source

    import optionDefinitions from 'mongoose-data-seed/src/lib/commands/init/option-definitions.js'

Init command option defenitions

### public optionDefinitions: Object[] source

    import optionDefinitions from 'mongoose-data-seed/src/lib/commands/run/option-definitions.js'

Run command option defenitions

### public systemConfigTemplate: string source

    import {systemConfigTemplate} from 'mongoose-data-seed/src/lib/constants.js'

system template for user-config path

### public systemSeederTemplate: string source

    import {systemSeederTemplate} from 'mongoose-data-seed/src/lib/constants.js'

system seeder template path

### public usageGuide: string source

    import usageGuide from 'mongoose-data-seed/src/lib/commands/help/usage-guide.js'

Help command user guide

### public usageGuide: string source

    import usageGuide from 'mongoose-data-seed/src/lib/commands/run/usage-guide.js'

Run command user guide