README.md (1624B)
1 <!-- 2 3 @license Apache-2.0 4 5 Copyright (c) 2021 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 # IS_MOBILE 22 23 > Check if the current environment is a mobile device. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var IS_MOBILE = require( '@stdlib/assert/is-mobile' ); 31 ``` 32 33 #### IS_MOBILE 34 35 `Boolean` indicating if the current environment is a mobile device. 36 37 ```javascript 38 var bool = IS_MOBILE; 39 // returns <boolean> 40 ``` 41 42 </section> 43 44 <!-- /.usage --> 45 46 <section class="notes"> 47 48 ## Notes 49 50 - In order to determine whether the current environment is a mobile device, the implementation checks whether the User Agent contains the string "Mobi" per the [MDN recommendations][mdn-mobile]. 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 IS_MOBILE = require( '@stdlib/assert/is-mobile' ); 64 65 console.log( IS_MOBILE ); 66 // => <boolean> 67 ``` 68 69 </section> 70 71 <!-- /.examples --> 72 73 <section class="links"> 74 75 76 [mdn-mobile]: https://developer.mozilla.org/en-US/docs/Web/HTTP/Browser_detection_using_the_user_agent#mobile_tablet_or_desktop 77 78 </section> 79 80 <!-- /.links -->