time-to-botec/squiggle/node_modules/@stdlib/time/seconds-in-month/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

50 lines
1.2 KiB
Plaintext

{{alias}}( [month[, year]] )
Returns the number of seconds in a month.
By default, the function returns the number of seconds in the current month
of the current year (according to local time). To determine the number of
seconds for a particular month and year, provide `month` and `year`
arguments.
A `month` may be either a month's integer value, three letter abbreviation,
or full name (case insensitive).
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
----------
month: string|Date|integer (optional)
Month.
year: integer (optional)
Year.
Returns
-------
out: integer
Seconds in a month.
Examples
--------
> var num = {{alias}}()
<number>
> num = {{alias}}( 2 )
<number>
> num = {{alias}}( 2, 2016 )
2505600
> num = {{alias}}( 2, 2017 )
2419200
// Other ways to supply month:
> num = {{alias}}( 'feb', 2016 )
2505600
> num = {{alias}}( 'february', 2016 )
2505600
See Also
--------