README.md (6117B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2018 The Stdlib Authors. 6 7 Licensed under the Apache License, Version 2.0 (the "License"); 8 you may not use this file except in compliance with the License. 9 You may obtain a copy of the License at 10 11 http://www.apache.org/licenses/LICENSE-2.0 12 13 Unless required by applicable law or agreed to in writing, software 14 distributed under the License is distributed on an "AS IS" BASIS, 15 WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. 16 See the License for the specific language governing permissions and 17 limitations under the License. 18 19 --> 20 21 # Constants 22 23 > Time constants. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var constants = require( '@stdlib/constants/time' ); 31 ``` 32 33 #### constants 34 35 Time constants. 36 37 ```javascript 38 var c = constants; 39 // returns {...} 40 ``` 41 42 <!-- <toc pattern="*"> --> 43 44 <div class="namespace-toc"> 45 46 - <span class="signature">[`HOURS_IN_DAY`][@stdlib/constants/time/hours-in-day]</span><span class="delimiter">: </span><span class="description">number of hours in a day.</span> 47 - <span class="signature">[`HOURS_IN_WEEK`][@stdlib/constants/time/hours-in-week]</span><span class="delimiter">: </span><span class="description">number of hours in a week.</span> 48 - <span class="signature">[`MILLISECONDS_IN_DAY`][@stdlib/constants/time/milliseconds-in-day]</span><span class="delimiter">: </span><span class="description">number of milliseconds in a day.</span> 49 - <span class="signature">[`MILLISECONDS_IN_HOUR`][@stdlib/constants/time/milliseconds-in-hour]</span><span class="delimiter">: </span><span class="description">number of milliseconds in an hour.</span> 50 - <span class="signature">[`MILLISECONDS_IN_MINUTE`][@stdlib/constants/time/milliseconds-in-minute]</span><span class="delimiter">: </span><span class="description">number of milliseconds in a minute.</span> 51 - <span class="signature">[`MILLISECONDS_IN_SECOND`][@stdlib/constants/time/milliseconds-in-second]</span><span class="delimiter">: </span><span class="description">number of milliseconds in a second.</span> 52 - <span class="signature">[`MILLISECONDS_IN_WEEK`][@stdlib/constants/time/milliseconds-in-week]</span><span class="delimiter">: </span><span class="description">number of milliseconds in a week.</span> 53 - <span class="signature">[`MINUTES_IN_DAY`][@stdlib/constants/time/minutes-in-day]</span><span class="delimiter">: </span><span class="description">number of minutes in a day.</span> 54 - <span class="signature">[`MINUTES_IN_HOUR`][@stdlib/constants/time/minutes-in-hour]</span><span class="delimiter">: </span><span class="description">number of minutes in an hour.</span> 55 - <span class="signature">[`MINUTES_IN_WEEK`][@stdlib/constants/time/minutes-in-week]</span><span class="delimiter">: </span><span class="description">number of minutes in a week.</span> 56 - <span class="signature">[`MONTHS_IN_YEAR`][@stdlib/constants/time/months-in-year]</span><span class="delimiter">: </span><span class="description">number of months in a year.</span> 57 - <span class="signature">[`SECONDS_IN_DAY`][@stdlib/constants/time/seconds-in-day]</span><span class="delimiter">: </span><span class="description">number of seconds in a day.</span> 58 - <span class="signature">[`SECONDS_IN_HOUR`][@stdlib/constants/time/seconds-in-hour]</span><span class="delimiter">: </span><span class="description">number of seconds in an hour.</span> 59 - <span class="signature">[`SECONDS_IN_MINUTE`][@stdlib/constants/time/seconds-in-minute]</span><span class="delimiter">: </span><span class="description">number of seconds in a minute.</span> 60 - <span class="signature">[`SECONDS_IN_WEEK`][@stdlib/constants/time/seconds-in-week]</span><span class="delimiter">: </span><span class="description">number of seconds in a week.</span> 61 62 </div> 63 64 <!-- </toc> --> 65 66 </section> 67 68 <!-- /.usage --> 69 70 <section class="examples"> 71 72 ## Examples 73 74 <!-- TODO: better examples --> 75 76 <!-- eslint no-undef: "error" --> 77 78 ```javascript 79 var objectKeys = require( '@stdlib/utils/keys' ); 80 var constants = require( '@stdlib/constants/time' ); 81 82 console.log( objectKeys( constants ) ); 83 ``` 84 85 </section> 86 87 <!-- /.examples --> 88 89 <section class="links"> 90 91 <!-- <toc-links> --> 92 93 [@stdlib/constants/time/hours-in-day]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/hours-in-day 94 95 [@stdlib/constants/time/hours-in-week]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/hours-in-week 96 97 [@stdlib/constants/time/milliseconds-in-day]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/milliseconds-in-day 98 99 [@stdlib/constants/time/milliseconds-in-hour]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/milliseconds-in-hour 100 101 [@stdlib/constants/time/milliseconds-in-minute]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/milliseconds-in-minute 102 103 [@stdlib/constants/time/milliseconds-in-second]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/milliseconds-in-second 104 105 [@stdlib/constants/time/milliseconds-in-week]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/milliseconds-in-week 106 107 [@stdlib/constants/time/minutes-in-day]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/minutes-in-day 108 109 [@stdlib/constants/time/minutes-in-hour]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/minutes-in-hour 110 111 [@stdlib/constants/time/minutes-in-week]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/minutes-in-week 112 113 [@stdlib/constants/time/months-in-year]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/months-in-year 114 115 [@stdlib/constants/time/seconds-in-day]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/seconds-in-day 116 117 [@stdlib/constants/time/seconds-in-hour]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/seconds-in-hour 118 119 [@stdlib/constants/time/seconds-in-minute]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/seconds-in-minute 120 121 [@stdlib/constants/time/seconds-in-week]: https://www.npmjs.com/package/@stdlib/constants/tree/main/time/seconds-in-week 122 123 <!-- </toc-links> --> 124 125 </section> 126 127 <!-- /.links -->