time-to-botec/squiggle/node_modules/@stdlib/constants/time/milliseconds-in-week/README.md

91 lines
1.8 KiB
Markdown
Raw Normal View History

<!--
@license Apache-2.0
Copyright (c) 2018 The Stdlib Authors.
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
-->
# Milliseconds in a Week
> Number of milliseconds in a week.
<section class="usage">
## Usage
```javascript
var MILLISECONDS_IN_WEEK = require( '@stdlib/constants/time/milliseconds-in-week' );
```
#### MILLISECONDS_IN_WEEK
Number of milliseconds in a week.
```javascript
var bool = ( MILLISECONDS_IN_WEEK === 604800000 );
// returns true
```
</section>
<!-- /.usage -->
<section class="notes">
## Notes
- 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.
</section>
<!-- /.notes -->
<section class="examples">
## Examples
<!-- eslint no-undef: "error" -->
```javascript
var randu = require( '@stdlib/random/base/randu' );
var roundn = require( '@stdlib/math/base/special/roundn' );
var MILLISECONDS_IN_WEEK = require( '@stdlib/constants/time/milliseconds-in-week' );
var ms;
var w;
var i;
function wks2ms( wks ) {
return wks * MILLISECONDS_IN_WEEK;
}
for ( i = 0; i < 10; i++ ) {
w = roundn( randu()*20.0, -2 );
ms = wks2ms( w );
console.log( '%d weeks => %d milliseconds', w, ms );
}
```
</section>
<!-- /.examples -->
<section class="links">
</section>
<!-- /.links -->