1 | # periodicjs.core.utilities
|
2 |
|
3 | Periodic's Core Utilities module contains a group of utility functions for restarting periodic's express application and helper functions to manipulate strings and other data structures
|
4 |
|
5 | [API Documentation](https://github.com/typesettin/periodicjs.core.utilities/blob/master/doc/api.md)
|
6 |
|
7 | ## Installation
|
8 |
|
9 | ```
|
10 | $ npm install periodicjs.core.utilities
|
11 | ```
|
12 |
|
13 | This is a part of Periodic's core.
|
14 |
|
15 | ## Usage
|
16 |
|
17 | ### Querying for tag
|
18 | *JavaScript*
|
19 | ```javascript
|
20 | var Utilities = require('periodicjs.core.utilities'),
|
21 | CoreUtilities = new Utilities(resources),
|
22 | Tag = mongoose.model('Tag');
|
23 | req.controllerData = (req.controllerData) ? req.controllerData : {};
|
24 |
|
25 | var createTag = function (req, res) {
|
26 | var newtag = CoreUtilities.removeEmptyObjectValues(req.body);
|
27 | newtag.name = CoreUtilities.makeNiceName(newtag.title);
|
28 | newtag.author = req.user._id;
|
29 |
|
30 | CoreController.createModel({
|
31 | model: Tag,
|
32 | newdoc: newtag,
|
33 | res: res,
|
34 | req: req,
|
35 | successredirect: '/p-admin/tag/edit/',
|
36 | appendid: true
|
37 | });
|
38 | };
|
39 | ```
|
40 |
|
41 | ##Development
|
42 | *Make sure you have grunt installed*
|
43 | ```
|
44 | $ npm install -g grunt-cli
|
45 | ```
|
46 |
|
47 | Then run grunt watch
|
48 | ```
|
49 | $ grunt watch
|
50 | ```
|
51 | For generating documentation
|
52 | ```
|
53 | $ grunt doc
|
54 | $ jsdoc2md lib/**/*.js index.js > doc/api.md
|
55 | ```
|
56 | ##Notes
|
57 | * Check out https://github.com/typesettin/periodicjs for the full Periodic Documentation |
\ | No newline at end of file |