time-to-botec/squiggle/node_modules/@stdlib/time/seconds-in-year/docs/repl.txt
NunoSempere b6addc7f05 feat: add the node modules
Necessary in order to clearly see the squiggle hotwiring.
2022-12-03 12:44:49 +00:00

35 lines
886 B
Plaintext

{{alias}}( [value] )
Returns the number of seconds in a year according to the Gregorian calendar.
By default, the function returns the number of seconds in the current year
(according to local time). To determine the number of seconds for a
particular year, provide either a year or a `Date` object.
The function's return value is a generalization and does **not** take into
account inaccuracies due to daylight savings conventions, crossing
timezones, or other complications with time and dates.
Parameters
----------
value: integer|Date (optional)
Year or `Date` object.
Returns
-------
out: integer
Number of seconds in a year.
Examples
--------
> var num = {{alias}}()
<number>
> num = {{alias}}( 2016 )
31622400
> num = {{alias}}( 2017 )
31536000
See Also
--------