README.md (1847B)
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 # isDateObject 22 23 > Test if a value is a [Date][mdn-date-object] object. 24 25 <section class="usage"> 26 27 ## Usage 28 29 ```javascript 30 var isDateObject = require( '@stdlib/assert/is-date-object' ); 31 ``` 32 33 #### isDateObject( value ) 34 35 Tests if a value is a [`Date`][mdn-date-object] object. 36 37 ```javascript 38 var bool = isDateObject( new Date() ); 39 // returns true 40 41 bool = isDateObject( '2017-01-01' ); 42 // returns false 43 ``` 44 45 </section> 46 47 <!-- /.usage --> 48 49 <section class="examples"> 50 51 ## Examples 52 53 <!-- eslint-disable no-empty-function, no-restricted-syntax --> 54 55 <!-- eslint no-undef: "error" --> 56 57 ```javascript 58 var isDateObject = require( '@stdlib/assert/is-date-object' ); 59 60 var bool = isDateObject( new Date() ); 61 // returns true 62 63 bool = isDateObject( '2017-01-01' ); 64 // returns false 65 66 bool = isDateObject( 5 ); 67 // returns false 68 69 bool = isDateObject( null ); 70 // returns false 71 72 bool = isDateObject( void 0 ); 73 // returns false 74 75 bool = isDateObject( {} ); 76 // returns false 77 78 bool = isDateObject( [] ); 79 // returns false 80 81 bool = isDateObject( function Date() {} ); 82 // returns false 83 ``` 84 85 </section> 86 87 <!-- /.examples --> 88 89 <section class="links"> 90 91 [mdn-date-object]: https://developer.mozilla.org/en-US/docs/Web/JavaScript/Reference/Global_Objects/Date 92 93 </section> 94 95 <!-- /.links -->