index.js (4493B)
1 /** 2 * @license Apache-2.0 3 * 4 * Copyright (c) 2018 The Stdlib Authors. 5 * 6 * Licensed under the Apache License, Version 2.0 (the "License"); 7 * you may not use this file except in compliance with the License. 8 * You may obtain a copy of the License at 9 * 10 * http://www.apache.org/licenses/LICENSE-2.0 11 * 12 * Unless required by applicable law or agreed to in writing, software 13 * distributed under the License is distributed on an "AS IS" BASIS, 14 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 15 * See the License for the specific language governing permissions and 16 * limitations under the License. 17 */ 18 19 'use strict'; 20 21 /* 22 * When adding modules to the namespace, ensure that they are added in alphabetical order according to module name. 23 */ 24 25 // MODULES // 26 27 var setReadOnly = require( '@stdlib/utils/define-read-only-property' ); 28 29 30 // MAIN // 31 32 /** 33 * Top-level namespace. 34 * 35 * @namespace ns 36 */ 37 var ns = {}; 38 39 /** 40 * @name HOURS_IN_DAY 41 * @memberof ns 42 * @readonly 43 * @constant 44 * @type {number} 45 * @see {@link module:@stdlib/constants/time/hours-in-day} 46 */ 47 setReadOnly( ns, 'HOURS_IN_DAY', require( './../../time/hours-in-day' ) ); 48 49 /** 50 * @name HOURS_IN_WEEK 51 * @memberof ns 52 * @readonly 53 * @constant 54 * @type {number} 55 * @see {@link module:@stdlib/constants/time/hours-in-week} 56 */ 57 setReadOnly( ns, 'HOURS_IN_WEEK', require( './../../time/hours-in-week' ) ); 58 59 /** 60 * @name MILLISECONDS_IN_DAY 61 * @memberof ns 62 * @readonly 63 * @constant 64 * @type {number} 65 * @see {@link module:@stdlib/constants/time/milliseconds-in-day} 66 */ 67 setReadOnly( ns, 'MILLISECONDS_IN_DAY', require( './../../time/milliseconds-in-day' ) ); 68 69 /** 70 * @name MILLISECONDS_IN_HOUR 71 * @memberof ns 72 * @readonly 73 * @constant 74 * @type {number} 75 * @see {@link module:@stdlib/constants/time/milliseconds-in-hour} 76 */ 77 setReadOnly( ns, 'MILLISECONDS_IN_HOUR', require( './../../time/milliseconds-in-hour' ) ); 78 79 /** 80 * @name MILLISECONDS_IN_MINUTE 81 * @memberof ns 82 * @readonly 83 * @constant 84 * @type {number} 85 * @see {@link module:@stdlib/constants/time/milliseconds-in-minute} 86 */ 87 setReadOnly( ns, 'MILLISECONDS_IN_MINUTE', require( './../../time/milliseconds-in-minute' ) ); 88 89 /** 90 * @name MILLISECONDS_IN_SECOND 91 * @memberof ns 92 * @readonly 93 * @constant 94 * @type {number} 95 * @see {@link module:@stdlib/constants/time/milliseconds-in-second} 96 */ 97 setReadOnly( ns, 'MILLISECONDS_IN_SECOND', require( './../../time/milliseconds-in-second' ) ); 98 99 /** 100 * @name MILLISECONDS_IN_WEEK 101 * @memberof ns 102 * @readonly 103 * @constant 104 * @type {number} 105 * @see {@link module:@stdlib/constants/time/milliseconds-in-week} 106 */ 107 setReadOnly( ns, 'MILLISECONDS_IN_WEEK', require( './../../time/milliseconds-in-week' ) ); 108 109 /** 110 * @name MINUTES_IN_DAY 111 * @memberof ns 112 * @readonly 113 * @constant 114 * @type {number} 115 * @see {@link module:@stdlib/constants/time/minutes-in-day} 116 */ 117 setReadOnly( ns, 'MINUTES_IN_DAY', require( './../../time/minutes-in-day' ) ); 118 119 /** 120 * @name MINUTES_IN_HOUR 121 * @memberof ns 122 * @readonly 123 * @constant 124 * @type {number} 125 * @see {@link module:@stdlib/constants/time/minutes-in-hour} 126 */ 127 setReadOnly( ns, 'MINUTES_IN_HOUR', require( './../../time/minutes-in-hour' ) ); 128 129 /** 130 * @name MINUTES_IN_WEEK 131 * @memberof ns 132 * @readonly 133 * @constant 134 * @type {number} 135 * @see {@link module:@stdlib/constants/time/minutes-in-week} 136 */ 137 setReadOnly( ns, 'MINUTES_IN_WEEK', require( './../../time/minutes-in-week' ) ); 138 139 /** 140 * @name MONTHS_IN_YEAR 141 * @memberof ns 142 * @readonly 143 * @constant 144 * @type {number} 145 * @see {@link module:@stdlib/constants/time/months-in-year} 146 */ 147 setReadOnly( ns, 'MONTHS_IN_YEAR', require( './../../time/months-in-year' ) ); 148 149 /** 150 * @name SECONDS_IN_DAY 151 * @memberof ns 152 * @readonly 153 * @constant 154 * @type {number} 155 * @see {@link module:@stdlib/constants/time/seconds-in-day} 156 */ 157 setReadOnly( ns, 'SECONDS_IN_DAY', require( './../../time/seconds-in-day' ) ); 158 159 /** 160 * @name SECONDS_IN_HOUR 161 * @memberof ns 162 * @readonly 163 * @constant 164 * @type {number} 165 * @see {@link module:@stdlib/constants/time/seconds-in-hour} 166 */ 167 setReadOnly( ns, 'SECONDS_IN_HOUR', require( './../../time/seconds-in-hour' ) ); 168 169 /** 170 * @name SECONDS_IN_MINUTE 171 * @memberof ns 172 * @readonly 173 * @constant 174 * @type {number} 175 * @see {@link module:@stdlib/constants/time/seconds-in-minute} 176 */ 177 setReadOnly( ns, 'SECONDS_IN_MINUTE', require( './../../time/seconds-in-minute' ) ); 178 179 /** 180 * @name SECONDS_IN_WEEK 181 * @memberof ns 182 * @readonly 183 * @constant 184 * @type {number} 185 * @see {@link module:@stdlib/constants/time/seconds-in-week} 186 */ 187 setReadOnly( ns, 'SECONDS_IN_WEEK', require( './../../time/seconds-in-week' ) ); 188 189 190 // EXPORTS // 191 192 module.exports = ns;