@stdlib/assert-is-current-year
v0.2.2
Published
Test if a value is the current year.
Downloads
12
Readme
isCurrentYear
Test if a value is the current year.
Installation
npm install @stdlib/assert-is-current-year
Usage
var isCurrentYear = require( '@stdlib/assert-is-current-year' );
isCurrentYear( value )
Tests if a value
is either an integer equal to the current year or a Date
object representing the current year.
var currentYear = require( '@stdlib/time-current-year' );
var bool = isCurrentYear( currentYear() );
// returns true
bool = isCurrentYear( 2021 );
// returns false
Examples
var currentYear = require( '@stdlib/time-current-year' );
var isCurrentYear = require( '@stdlib/assert-is-current-year' );
var bool = isCurrentYear( new Date() );
// returns true
bool = isCurrentYear( currentYear() );
// returns true
bool = isCurrentYear( 2021 );
// returns false
bool = isCurrentYear( null );
// returns false
See Also
@stdlib/assert-is-current-year-cli
: CLI package for use as a command-line utility.
Notice
This package is part of stdlib, a standard library for JavaScript and Node.js, with an emphasis on numerical and scientific computing. The library provides a collection of robust, high performance libraries for mathematics, statistics, streams, utilities, and more.
For more information on the project, filing bug reports and feature requests, and guidance on how to develop stdlib, see the main project repository.
Community
License
See LICENSE.
Copyright
Copyright © 2016-2024. The Stdlib Authors.