Skip to content

Commit 1348978

Browse files
committed
docs: expand explanation of timezone option
closes #620 closes #1680
1 parent 9756af7 commit 1348978

File tree

1 file changed

+1
-1
lines changed

1 file changed

+1
-1
lines changed

Readme.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -192,7 +192,7 @@ When establishing a connection, you can set the following options:
192192
* `charset`: The charset for the connection. This is called "collation" in the SQL-level
193193
of MySQL (like `utf8_general_ci`). If a SQL-level charset is specified (like `utf8mb4`)
194194
then the default collation for that charset is used. (Default: `'UTF8_GENERAL_CI'`)
195-
* `timezone`: The timezone used to store local dates. (Default: `'local'`)
195+
* `timezone`: The timezone configured on the MySQL server. This is used to type cast server date/time values to JavaScript `Date` object and vice versa. This can be `'local'`, `'Z'`, or an offset in the form `+HH:MM` or `-HH:MM`. (Default: `'local'`)
196196
* `connectTimeout`: The milliseconds before a timeout occurs during the initial connection
197197
to the MySQL server. (Default: `10000`)
198198
* `stringifyObjects`: Stringify objects instead of converting to values. See

0 commit comments

Comments
 (0)