Json Configurator Store
Table of Contents
ProjectManagement
createProject
Creates a new Folder in File System using process.env.PROJECTS_FOLDER and given projectName. Creates sub-folders for configurations and JSON Schemas
Parameters
-
projectName
string
Returns boolean return true if a new project was created, false if it already exists.
getAllProjects
Retrieves a list of all existing projects in the File System
getProjectConfigurations
Retrieves the configurations filenames inside the directory of projectName
Parameters
-
projectName
-
Throws Error Project does not exist
ConfigurationManagement
getConfiguration
Retrieves the Configuration File with configName for given projectName
Parameters
-
projectName
{string} - The project that contains the requested configuration file -
configName
{string} - The requested configuration file -
suffix
{string=} - a suffix to append to the filename configName when retrieving it.
Returns object
createConfiguration
Creates a new Configuration File named configName with configData inside of an existing project with given projectName
Parameters
-
projectName
string The project that contains the requested configuration file -
configName
string The requested configuration file -
configData
string The configuration you wish to store -
suffix
string? a suffix to append to the filename
SchemaManagement
getSchema
Retrieves the Schema File with schemaName for given projectName
Parameters
-
projectName
{string} - The project that contains the requested schema file -
schemaName
{string} - The requested schema file -
suffix
{string=} - a suffix to append to the filename schemaName when retrieving it.
Returns object
createSchema
Creates a new Schema File named schemaName with schemaData inside of an existing project with given projectName