Main functions and classes of the FCF framework
Révision | b741af01a4f28342bc81dd3b81d62d5c37d34495 (tree) |
---|---|
l'heure | 2022-12-06 10:15:00 |
Auteur | vmarkin |
Commiter | vmarkin |
comments styles
@@ -24,9 +24,11 @@ | ||
24 | 24 | const _isServer = typeof module === "object" && typeof module.filename !== "undefined"; |
25 | 25 | |
26 | 26 | |
27 | - // | |
27 | + | |
28 | + ////////////////////////////////////////////////////////////////////////////// | |
28 | 29 | // SERVER SIDE INCLUDES |
29 | - // | |
30 | + ////////////////////////////////////////////////////////////////////////////// | |
31 | + | |
30 | 32 | |
31 | 33 | |
32 | 34 | let libResolver; |
@@ -37,9 +39,10 @@ | ||
37 | 39 | } |
38 | 40 | |
39 | 41 | |
40 | - // | |
42 | + | |
43 | + ////////////////////////////////////////////////////////////////////////////// | |
41 | 44 | // STRING FUNCTIONS |
42 | - // | |
45 | + ////////////////////////////////////////////////////////////////////////////// | |
43 | 46 | |
44 | 47 | |
45 | 48 |
@@ -467,6 +470,7 @@ | ||
467 | 470 | } |
468 | 471 | |
469 | 472 | |
473 | + | |
470 | 474 | /// @fn string fcf.id(number a_size = 32, boolean a_unsafeFirstChar = false) |
471 | 475 | /// @brief Creates a string from random characters in hex format |
472 | 476 | /// @param number a_size default = 32 - Generated string size |
@@ -607,9 +611,9 @@ | ||
607 | 611 | |
608 | 612 | |
609 | 613 | |
610 | - // | |
614 | + ////////////////////////////////////////////////////////////////////////////// | |
611 | 615 | // DATA FUNCTIONS |
612 | - // | |
616 | + ////////////////////////////////////////////////////////////////////////////// | |
613 | 617 | |
614 | 618 | |
615 | 619 |
@@ -889,6 +893,8 @@ | ||
889 | 893 | } |
890 | 894 | } |
891 | 895 | |
896 | + | |
897 | + | |
892 | 898 | /// @fn fcf.getApproximateMSize(a_value) |
893 | 899 | /// @brief A very approximate estimate of the memory occupied by an object in bytes. |
894 | 900 | /// @details The error can reach up to 10 times. |
@@ -917,6 +923,7 @@ | ||
917 | 923 | } |
918 | 924 | |
919 | 925 | |
926 | + | |
920 | 927 | /// @fn object fcf.append(object|array a_dstObject, object|array a_srcObject1, object|array a_srcObject2, ...) |
921 | 928 | /// @fn object fcf.append(boolean a_recursionCopy, object a_dstObject, object a_srcObject1, object a_srcObject2, ...) |
922 | 929 | /// @brief Copies properties from a_srcObjectN objects to the receiving object |
@@ -1234,9 +1241,9 @@ | ||
1234 | 1241 | |
1235 | 1242 | |
1236 | 1243 | |
1237 | - // | |
1238 | - // BASE FUNCTIONS & CLASSES | |
1239 | - // | |
1244 | + ////////////////////////////////////////////////////////////////////////////// | |
1245 | + // FUNCTIONS AND CLASSES OF BASIC FUNCTIONALITY | |
1246 | + ////////////////////////////////////////////////////////////////////////////// | |
1240 | 1247 | |
1241 | 1248 | |
1242 | 1249 |
@@ -1273,12 +1280,6 @@ | ||
1273 | 1280 | |
1274 | 1281 | |
1275 | 1282 | |
1276 | - // | |
1277 | - // FUNCTIONS AND CLASSES OF BASIC FUNCTIONALITY | |
1278 | - // | |
1279 | - | |
1280 | - | |
1281 | - | |
1282 | 1283 | /// @fn fcf.Actions fcf.actions(a_options = {deferred: false, noexcept: false}) |
1283 | 1284 | /// @fn fcf.Actions fcf.actions(a_cb, a_options = {deferred: false, noexcept: false}) |
1284 | 1285 | /// @fn fcf.Actions fcf.actions(Promise a_promise, a_options = {deferred: false, noexcept: false}) |
@@ -1304,10 +1305,6 @@ | ||
1304 | 1305 | } |
1305 | 1306 | |
1306 | 1307 | |
1307 | - const ACTIONS_FLAGS_DEFERRED = 1; | |
1308 | - const ACTIONS_FLAGS_NOEXCEPT = 2; | |
1309 | - const ACTIONS_FLAGS_RUN = 4; | |
1310 | - | |
1311 | 1308 | |
1312 | 1309 | /// @class fcf.Actions |
1313 | 1310 | /// @brief The analogue of the Promise class with extended functionality. |
@@ -1696,6 +1693,7 @@ | ||
1696 | 1693 | } |
1697 | 1694 | |
1698 | 1695 | |
1696 | + | |
1699 | 1697 | /// @method fcf.Actions finally(function a_cb) |
1700 | 1698 | /// @brief Adds a callback to the run queue that is also called will be called on error |
1701 | 1699 | /// @details When the a_cb function is called, this is set to fcf.Actions object |
@@ -1783,6 +1781,8 @@ | ||
1783 | 1781 | return this; |
1784 | 1782 | } |
1785 | 1783 | |
1784 | + | |
1785 | + | |
1786 | 1786 | /// @method mixed exception() |
1787 | 1787 | /// @brief Throws an exception if the object of actions is in a state of error |
1788 | 1788 | /// @result fcf.Actions - Self object |
@@ -1934,6 +1934,10 @@ | ||
1934 | 1934 | } |
1935 | 1935 | } |
1936 | 1936 | |
1937 | + const ACTIONS_FLAGS_DEFERRED = 1; | |
1938 | + const ACTIONS_FLAGS_NOEXCEPT = 2; | |
1939 | + const ACTIONS_FLAGS_RUN = 4; | |
1940 | + | |
1937 | 1941 | |
1938 | 1942 | |
1939 | 1943 | fcf.module = (a_options) => { |