1 | <a name="Utilities"></a>
|
2 | #class: Utilities
|
3 | **Members**
|
4 |
|
5 | * [class: Utilities](#Utilities)
|
6 | * [new Utilities()](#new_Utilities)
|
7 | * [utilities.isValidObjectID(str)](#Utilities#isValidObjectID)
|
8 | * [utilities.run_cmd(cmd, args, callBack)](#Utilities#run_cmd)
|
9 | * [utilities.async_run_cmd(cmd, args, asynccallback, callBack)](#Utilities#async_run_cmd)
|
10 | * [utilities.restart_app(options)](#Utilities#restart_app)
|
11 | * [utilities.sortObject(dir, field)](#Utilities#sortObject)
|
12 | * [utilities.removeEmptyObjectValues(obj)](#Utilities#removeEmptyObjectValues)
|
13 | * [utilities.replaceBooleanStringObjectValues(obj)](#Utilities#replaceBooleanStringObjectValues)
|
14 | * [utilities.removePrivateInfo(obj)](#Utilities#removePrivateInfo)
|
15 | * [utilities.stripTags(textinput)](#Utilities#stripTags)
|
16 | * [utilities.makeNiceName(username)](#Utilities#makeNiceName)
|
17 | * [utilities.makeNiceAttribute(username)](#Utilities#makeNiceAttribute)
|
18 | * [utilities.getAdminMenu(options)](#Utilities#getAdminMenu)
|
19 |
|
20 | <a name="new_Utilities"></a>
|
21 | ##new Utilities()
|
22 | A group of utility functions for restarting periodic's express application and helper functions to manipulate strings and other data structures.
|
23 |
|
24 | **Author**: Yaw Joseph Etse
|
25 | **License**: MIT
|
26 | **Copyright**: Copyright (c) 2014 Typesettin. All rights reserved.
|
27 | <a name="Utilities#isValidObjectID"></a>
|
28 | ##utilities.isValidObjectID(str)
|
29 | simple helper function for validating mongo object IDs
|
30 |
|
31 | **Params**
|
32 |
|
33 | - str `string` - mongo object id
|
34 |
|
35 | **Returns**: `Boolean` - [description]
|
36 | <a name="Utilities#run_cmd"></a>
|
37 | ##utilities.run_cmd(cmd, args, callBack)
|
38 | shorthand method for running shell commands
|
39 |
|
40 | **Params**
|
41 |
|
42 | - cmd `string` - shell command
|
43 | - args `array` - command line arguments
|
44 | - callBack `function` - async callback
|
45 |
|
46 | **Returns**: `function` - callback(response)
|
47 | <a name="Utilities#async_run_cmd"></a>
|
48 | ##utilities.async_run_cmd(cmd, args, asynccallback, callBack)
|
49 | shorthand method for running shell commands
|
50 |
|
51 | **Params**
|
52 |
|
53 | - cmd `string` - shell command
|
54 | - args `array` - command line arguments
|
55 | - asynccallback `function` - async callback
|
56 | - callBack `function` - callback
|
57 |
|
58 | **Returns**: `function` - callback(response)
|
59 | <a name="Utilities#restart_app"></a>
|
60 | ##utilities.restart_app(options)
|
61 | shorthand method for restarting periodic by updating the node script's watch file content/config/restart.json
|
62 |
|
63 | **Params**
|
64 |
|
65 | - options `object` - restartfile - define a custom restart file
|
66 |
|
67 | <a name="Utilities#sortObject"></a>
|
68 | ##utilities.sortObject(dir, field)
|
69 | custom object sort by field
|
70 |
|
71 | **Params**
|
72 |
|
73 | - dir `string` - either asc or desc
|
74 | - field `string` - object property to seach
|
75 |
|
76 | **Returns**: `function` - object sort compare function
|
77 | **Example**
|
78 | req.controllerData.searchdocuments = searchdocuments.sort(CoreUtilities.sortObject('desc', 'createdat'));
|
79 |
|
80 | <a name="Utilities#removeEmptyObjectValues"></a>
|
81 | ##utilities.removeEmptyObjectValues(obj)
|
82 | remove empty object properties that have empty values
|
83 |
|
84 | **Params**
|
85 |
|
86 | - obj `object` - object to remove empty fields from
|
87 |
|
88 | **Returns**: `object` - object with empty values removed
|
89 | <a name="Utilities#replaceBooleanStringObjectValues"></a>
|
90 | ##utilities.replaceBooleanStringObjectValues(obj)
|
91 | replace boolean strings with actual boolean values
|
92 |
|
93 | **Params**
|
94 |
|
95 | - obj `object` - object to substitute values
|
96 |
|
97 | **Returns**: `object` - object with boolean values
|
98 | **Example**
|
99 | updatedThemeSettings = CoreUtilities.replaceBooleanStringObjectValues(updatedThemeSettings);
|
100 |
|
101 | <a name="Utilities#removePrivateInfo"></a>
|
102 | ##utilities.removePrivateInfo(obj)
|
103 | remove private data from user objects
|
104 |
|
105 | **Params**
|
106 |
|
107 | - obj `object` - user object
|
108 |
|
109 | **Returns**: `object` - object with removed private data
|
110 | <a name="Utilities#stripTags"></a>
|
111 | ##utilities.stripTags(textinput)
|
112 | replace all non alpha numeric tags with dashes and lowercase
|
113 |
|
114 | **Params**
|
115 |
|
116 | - textinput `string` - string to manipulate
|
117 |
|
118 | **Returns**: `string` - manipulated string
|
119 | <a name="Utilities#makeNiceName"></a>
|
120 | ##utilities.makeNiceName(username)
|
121 | replace all non alpha numeric tags with dashes and lowercase
|
122 |
|
123 | **Params**
|
124 |
|
125 | - username `string` - string to manipulate
|
126 |
|
127 | **Returns**: `string` - manipulated string
|
128 | <a name="Utilities#makeNiceAttribute"></a>
|
129 | ##utilities.makeNiceAttribute(username)
|
130 | replace all non alpha numeric tags with dashes and lowercase
|
131 |
|
132 | **Params**
|
133 |
|
134 | - username `string` - string to manipulate
|
135 |
|
136 | **Returns**: `string` - manipulated string
|
137 | <a name="Utilities#getAdminMenu"></a>
|
138 | ##utilities.getAdminMenu(options)
|
139 | add additional admin interface items from periodic extensions
|
140 |
|
141 | **Params**
|
142 |
|
143 | - options `object` - config options
|
144 |
|
145 | **Returns**: `object` - admin menu json object
|