README.md (1802B)
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 # Seconds in a Week 22 23 > Number of seconds in a week. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var SECONDS_IN_WEEK = require( '@stdlib/constants/time/seconds-in-week' ); 31 ``` 32 33 #### SECONDS_IN_WEEK 34 35 Number of seconds in a week. 36 37 ```javascript 38 var bool = ( SECONDS_IN_WEEK === 604800 ); 39 // returns true 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="notes"> 47 48 ## Notes 49 50 - The value is a generalization and does **not** take into account inaccuracies due to daylight savings conventions, crossing timezones, or other complications with time and dates. 51 52 </section> 53 54 <!-- /.notes --> 55 56 <section class="examples"> 57 58 ## Examples 59 60 <!-- eslint no-undef: "error" --> 61 62 ```javascript 63 var randu = require( '@stdlib/random/base/randu' ); 64 var roundn = require( '@stdlib/math/base/special/roundn' ); 65 var SECONDS_IN_WEEK = require( '@stdlib/constants/time/seconds-in-week' ); 66 67 var secs; 68 var wks; 69 var i; 70 71 function wks2secs( wks ) { 72 return wks * SECONDS_IN_WEEK; 73 } 74 75 for ( i = 0; i < 10; i++ ) { 76 wks = roundn( randu()*20.0, -2 ); 77 secs = wks2secs( wks ); 78 console.log( '%d weeks => %d seconds', wks, secs ); 79 } 80 ``` 81 82 </section> 83 84 <!-- /.examples --> 85 86 <section class="links"> 87 88 </section> 89 90 <!-- /.links -->