time-to-botec

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

README.md (2326B)

      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 # isDateObjectArray
     22 
     23 > Test if a value is an array-like object containing only [Date][@stdlib/assert/is-date-object] objects.
     24 
     25 <section class="usage">
     26 
     27 ## Usage
     28 
     29 ```javascript
     30 var isDateObjectArray = require( '@stdlib/assert/is-date-object-array' );
     31 ```
     32 
     33 #### isDateObjectArray( value )
     34 
     35 Tests if a `value` is an array-like object containing **only** [`Date`][@stdlib/assert/is-date-object] objects.
     36 
     37 <!-- eslint-disable no-new-wrappers -->
     38 
     39 ```javascript
     40 var Number = require( '@stdlib/number/ctor' );
     41 
     42 var bool = isDateObjectArray( [ new Date(), new Date() ] );
     43 // returns true
     44 
     45 bool = isDateObjectArray( [ {}, new Number( 3.0 ) ] );
     46 // returns false
     47 
     48 bool = isDateObjectArray( [ {}, '3.0' ] );
     49 // returns false
     50 
     51 bool = isDateObjectArray( [] );
     52 // returns false
     53 
     54 bool = isDateObjectArray( [ null, {} ] );
     55 // returns false
     56 ```
     57 
     58 </section>
     59 
     60 <!-- /.usage -->
     61 
     62 <section class="examples">
     63 
     64 ## Examples
     65 
     66 <!-- eslint-disable no-new-wrappers -->
     67 
     68 <!-- eslint no-undef: "error" -->
     69 
     70 ```javascript
     71 var Number = require( '@stdlib/number/ctor' );
     72 var isDateObjectArray = require( '@stdlib/assert/is-date-object-array' );
     73 
     74 var bool = isDateObjectArray( [ new Date(), new Date(), new Date() ] );
     75 // returns true
     76 
     77 bool = isDateObjectArray( [ new Date(), new Number( 3 ) ] );
     78 // returns false
     79 
     80 bool = isDateObjectArray( [ new Date(), new String( 'abc' ), {} ] );
     81 // returns false
     82 
     83 bool = isDateObjectArray( [ [], {} ] );
     84 // returns false
     85 
     86 bool = isDateObjectArray( [ 'a', 'b' ] );
     87 // returns false
     88 
     89 bool = isDateObjectArray( [] );
     90 // returns false
     91 ```
     92 
     93 </section>
     94 
     95 <!-- /.examples -->
     96 
     97 <section class="links">
     98 
     99 [@stdlib/assert/is-date-object]: https://www.npmjs.com/package/@stdlib/assert/tree/main/is-date-object
    100 
    101 </section>
    102 
    103 <!-- /.links -->