time-to-botec

Benchmark sampling in different programming languages
Log | Files | Refs | README

README.md (1645B)

      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 # isArguments
     22 
     23 > Test if a value is an arguments object.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isArguments = require( '@stdlib/assert/is-arguments' );
     31 ```
     32 
     33 #### isArguments( value )
     34 
     35 Tests if a `value` is an `arguments` object.
     36 
     37 ```javascript
     38 function foo() {
     39     return arguments;
     40 }
     41 
     42 var bool = isArguments( foo() );
     43 // returns true
     44 
     45 bool = isArguments( [] );
     46 // returns false
     47 ```
     48 
     49 </section>
     50 
     51 <!-- /.usage -->
     52 
     53 <section class="examples">
     54 
     55 ## Examples
     56 
     57 <!-- eslint no-undef: "error" -->
     58 
     59 ```javascript
     60 var isArguments = require( '@stdlib/assert/is-arguments' );
     61 
     62 function foo() {
     63     return arguments;
     64 }
     65 
     66 var bool = isArguments( foo() );
     67 // returns true
     68 
     69 bool = isArguments( [] );
     70 // returns false
     71 
     72 bool = isArguments( {} );
     73 // returns false
     74 
     75 bool = isArguments( null );
     76 // returns false
     77 
     78 bool = isArguments( 'Arguments' );
     79 // returns false
     80 
     81 function Arguments() {
     82     return this;
     83 }
     84 bool = isArguments( new Arguments() );
     85 // returns false
     86 ```
     87 
     88 </section>
     89 
     90 <!-- /.examples -->
     91 
     92 <section class="links">
     93 
     94 </section>
     95 
     96 <!-- /.links -->