README.md (1949B)
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 # WeakMap Support 22 23 > Detect native [`WeakMap`][mdn-weakmap] support. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var hasWeakMapSupport = require( '@stdlib/assert/has-weakmap-support' ); 31 ``` 32 33 #### hasWeakMapSupport() 34 35 Detects if a runtime environment supports ES2015 [`WeakMap`][mdn-weakmap]. 36 37 ```javascript 38 var bool = hasWeakMapSupport(); 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 hasWeakMapSupport = require( '@stdlib/assert/has-weakmap-support' ); 54 55 var bool = hasWeakMapSupport(); 56 if ( bool ) { 57 console.log( 'Environment has WeakMap support.' ); 58 } else { 59 console.log( 'Environment lacks WeakMap support.' ); 60 } 61 ``` 62 63 </section> 64 65 <!-- /.examples --> 66 67 * * * 68 69 <section class="cli"> 70 71 ## CLI 72 73 <section class="usage"> 74 75 ### Usage 76 77 ```text 78 Usage: has-weakmap-support [options] 79 80 Options: 81 82 -h, --help Print this message. 83 -V, --version Print the package version. 84 ``` 85 86 </section> 87 88 <!-- /.usage --> 89 90 <section class="examples"> 91 92 ### Examples 93 94 ```bash 95 $ has-weakmap-support 96 <boolean> 97 ``` 98 99 </section> 100 101 <!-- /.examples --> 102 103 </section> 104 105 <!-- /.cli --> 106 107 <section class="links"> 108 109 [mdn-weakmap]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/WeakMap 110 111 </section> 112 113 <!-- /.links -->