README.md (1760B)
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 # Little Endian 22 23 > Check if an environment is [little endian][endianness]. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var IS_LITTLE_ENDIAN = require( '@stdlib/assert/is-little-endian' ); 31 ``` 32 33 #### IS_LITTLE_ENDIAN 34 35 `Boolean` indicating if an environment is [little endian][endianness]. 36 37 ```javascript 38 var bool = IS_LITTLE_ENDIAN; 39 // returns <boolean> 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="examples"> 47 48 ## Examples 49 50 <!-- eslint no-undef: "error" --> 51 52 ```javascript 53 var IS_LITTLE_ENDIAN = require( '@stdlib/assert/is-little-endian' ); 54 55 console.log( IS_LITTLE_ENDIAN ); 56 // => <boolean> 57 ``` 58 59 </section> 60 61 <!-- /.examples --> 62 63 * * * 64 65 <section class="cli"> 66 ## CLI 67 68 <section class="usage"> 69 70 ### Usage 71 72 ```text 73 Usage: is-little-endian [options] 74 75 Options: 76 77 -h, --help Print this message. 78 -V, --version Print the package version. 79 ``` 80 81 </section> 82 83 <!-- /.usage --> 84 85 <section class="examples"> 86 87 ### Examples 88 89 ```bash 90 $ is-little-endian 91 <boolean> 92 ``` 93 94 </section> 95 96 <!-- /.examples --> 97 98 </section> 99 100 <!-- /.cli --> 101 102 <section class="links"> 103 104 [endianness]: http://en.wikipedia.org/wiki/Endianness 105 106 </section> 107 108 <!-- /.links -->