node-caltime/index.js at dev · mickmcc/node-caltime · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
/**
 * Top-level module which provides all of the functions and constants.
 * @module caltime
 * @version 1.4.5
 *
 * @author Michael McCarthy
 * @copyright Michael McCarthy <michael.mccarthy@ieee.org> 2017-2018
 * @license MIT
 */

'use strict';

/* private ********************************************************************/

const timespanModule = require('./lib/timespan');
const datespanModule = require('./lib/datespan');
const timeruleModule = require('./lib/timerule');


/* exported functional constructors *******************************************/

/** Functional constructor which creates a TimeSpan object.
 * @public
 * @see {@link module:caltime/timespan~timeSpan} */
module.exports.timeSpan = timespanModule.timeSpan;

/** Functional constructor which creates a DateSpan object.
 * @public
 * @see {@link module:caltime/datespan~dateSpan}
 */
module.exports.dateSpan = datespanModule.dateSpan;

/** Functional constructor which creates a TimeRule object.
 * @public
 * @see {@link module:caltime/timerule~timeRule}
 */
module.exports.timeRule = timeruleModule.timeRule;


/* exported functions ++++++++++++++++++++++++++++++++++++++++++++++++++++++++*/

/**
 * Function used to merge DateSpan objects in an array.
 * @public
 * @see {@link module:caltime/datespan~mergeSpans}
 */
module.exports.mergeDateSpans = datespanModule.mergeSpans;

/** Function used to sort DateSpan objects in an array.
 * @public
 * @see {@link module:caltime/datespan~sortSpans}
 */
module.exports.sortDateSpans = datespanModule.sortSpans;

/**
 * Function used to count the number of time units which overlap with
 *  multiple DateSpan objects in an array.
 * @public
 * @see {@link module:caltime/datespan~measureSpans}
 */
module.exports.measureDateSpans = datespanModule.measureSpans;

/**
 * Function used to intersect the DateSpan objects in two arrays.
 * @public
 * @see {@link module:caltime/datespan~intersectSpans}
 */
module.exports.intersectDateSpans = datespanModule.intersectSpans;

/**
 * Function used to merge TimeSpan objects in an array.
 * @public
 * @see {@link module:caltime/timespan~mergeSpans}
 */
module.exports.mergeTimeSpans = timespanModule.mergeSpans;

/**
 * Function used to sort TimeSpan objects in an array.
 * @public
 * @see {@link module:caltime/timespan~sortSpans}
 */
module.exports.sortTimeSpans = timespanModule.sortSpans;

/* exported constants *********************************************************/

/** Object's data members provide all of the constants which are made
    available by the module. */
module.exports.constants = require('./lib/constants');

/** Version number of the module in SemVer string format. */
module.exports.VERSION = '1.4.5';