snooze | Restful API For NodeJS | REST library

To create a simple one-file snooze application an example is shown below. More advanced setups later in the README. It is recommended that beginners, intermediates, and advanced users use the snooze-baselib module unless there are specific reasons not to. The snooze-baselib module contains usefule Entities and importProcesses. Modules are a flexible wrapper or foundation for your project. They can be designed to share a set of functionality to other modules (and are not intended to run alone), or they can be designed to run your application. Modules greatest strength is that it allows sharing functionality easily and in an abstrated, modular way. To create a module use the snooze.module method. When creating a module the second param is required. It can be an empty array or an array of modules to import. All module methods that don't return a value returns itself making commands chainable. If the modules is already created you can access it be omitting the array. Importing modules lets you import functionality into your application seemlessly. Modules can be written yourself or downloaded using npm. snooze-baselib is a highly recommended starting point. Using it as an example, to install it and import it into your project do the following. If the npm module hasn't been required using require() snooze will try to do this automatically. If you are trying to import a local module (not from npm) require() it manually before you try to import it into another module. Note When a module is constructed the dependant modules will import immediately. A run processes may be what you use to run your app. Your module can define multiple run processes that will get called once wakeup or doRuns is called. It's recommended you should use wakeup instead. Run processes allow injected Entities. Config processes are called before run processes. Entities may define a config object. This is up to the writer of the entity to provide as well as document. Depending on how the Entity is written. Some entities may provide a config and an injectable, just a config, or just an injectable. See the documentation of the Entity for it's possible uses. Because I am a pun-master (i'm not), to start your snooze application you should wakeup. This will go through the configPreprocessors, config processes, and run processes in that order. A Service in pre-alpha is what is now a type of Entity in alpha. An Entity can be created and customized to serve any purpose. Using the recommended snooze-baselib module in your projects you get the service, value, and constant entities in your project. Other entities can be imported from other modules or created by the developer and shared through imports. An Entity can be injected into snooze processes or any "injectable function". They can also be injected into Entities that define a function for their constructor. Taking the service Entity from snooze-baselib we can create a Math service for our application. Note we don't include the dependencies here. When dependencies are defined, snooze will construct a module. When no dependencies are defined you are accessing the module. Entities come in different shapes and sizes. Lets create a bank app that prevents you from withdrawing more that $500 at a time. // lib/services/Bank.js (function() { 'use strict'; var snooze = require('snooze');. For more information on service, value, and constant, see the snooze-baselib README. Each module is responsible for importing it's own entities. You don't need to worry about importing the entities from a module you are importing. The module you are importing (say snooze-baselib) will import it's Entity types (service, value, and constant) as well as entities built on these types (like in our Math example). To create your own entities on these types and import them use the registerEntitiesFromPath method. You can specify the exact path of the file to import or use a globbing pattern. If the root of your app has a snooze.json file in it, snooze will load the contents into the config when it's constructed. Modules can be written to read the config and change the behavior of your application in the configuration or running phases of your application. The only available property in vanila snooze.json is the silent property. False be default but set to true and logs and warns will not print to the console.