json-configurator-store
<!-- Generated by documentation.js. Update this documentation by updating the source code. -->
Last updated a month ago by et123456 .
ISC · Repository · Bugs · Original npm · Tarball · package.json
$ cnpm install json-configurator-store 
SYNC missed versions from official npm registry.

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

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

Returns Array<string>

getProjectConfigurations

Retrieves the configurations filenames inside the directory of projectName

Parameters

  • projectName

  • Throws Error Project does not exist

Returns Array<string>

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

Returns Promise<boolean>

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

Parameters

  • projectName string The project that contains the requested schema file
  • schemaName string The requested schema file
  • schemaData string The schema you wish to store
  • suffix string? a suffix to append to the filename

Returns Promise<boolean>

Current Tags

  • 0.1.2                                ...           latest (a month ago)

3 Versions

  • 0.1.2                                ...           a month ago
  • 0.1.1                                ...           a month ago
  • 0.1.0                                ...           2 months ago
Maintainers (1)
Downloads
Today 0
This Week 0
This Month 0
Last Day 0
Last Week 0
Last Month 40
Dependencies (1)
Dev Dependencies (6)
Dependents (0)
None

Copyright 2014 - 2016 © taobao.org |