README.md (1341B)
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 # Max Uint32 22 23 > Maximum unsigned 32-bit integer. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var UINT32_MAX = require( '@stdlib/constants/uint32/max' ); 31 ``` 32 33 #### UINT32_MAX 34 35 Maximum unsigned 32-bit `integer`. 36 37 ```javascript 38 var bool = ( UINT32_MAX === 4294967295 ); 39 // returns true 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="notes"> 47 48 ## Notes 49 50 - `UINT32_MAX` is the maximum `array` length. 51 52 </section> 53 54 <!-- /.notes --> 55 56 <section class="examples"> 57 58 ## Examples 59 60 <!-- TODO: better example --> 61 62 <!-- eslint no-undef: "error" --> 63 64 ```javascript 65 var UINT32_MAX = require( '@stdlib/constants/uint32/max' ); 66 67 console.log( UINT32_MAX ); 68 // => 4294967295 69 ``` 70 71 <!-- </examples --> 72 73 <section class="links"> 74 75 </section> 76 77 <!-- /.links -->