doc/index.md

   1 # `luatz`
   2
   3 Requiring the base luatz module will give you a table of commonly used functions and submodules.
   4
   5 The table includes the following sub modules, which have their own documentation:
   6
   7   - `parse`: Parses common date/time formats
   8   - `timetable`: Class for date/time objects supporting normalisation
   9
  10
  11 ## `time ( )`
  12
  13 Returns the current unix timestamp using the most precise source available.
  14 See `gettime` for more information.
  15
  16
  17 ## `get_tz ( [timezone_name] )`
  18
  19 Returns a timezone object (see `tzinfo` documentation) for the given `timezone_name`.
  20 If `timezone_name` is `nil` then the local timezone is used.
  21 If `timezone_name` is an absolute path, then that `tzinfo` file is used
  22
  23 This uses the local [zoneinfo database](https://www.iana.org/time-zones);
  24 names are usually of the form `Country/Largest_City` e.g. "America/New_York".
  25 Check [wikipedia](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones) for an example list.
  26
  27
  28 ## `time_in ( timezone_name [, utc_ts] )`
  29
  30 Returns the current time in seconds since 1970-01-01 0:00:00 in the given timezone as a string,
  31 (same semantics as `get_tz`) at the given UTC time (defaults to now).