formatTime<includeMs extends boolean>( date: Date, timeZoneOffset?: number, includeMs?: includeMs,): includeMs extends unknown ? | `${bigint}:${bigint}:${bigint} AM` | `${bigint}:${bigint}:${bigint} PM` : includeMs extends false ? | `${bigint}:${bigint}:${bigint} AM` | `${bigint}:${bigint}:${bigint} PM` : | `${bigint}:${bigint}:${bigint}.${bigint} AM` | `${bigint}:${bigint}:${bigint}.${bigint} PM` Type Parameters
- includeMs extends boolean
Parameters
- date: Date
OptionaltimeZoneOffset: numberOptionalincludeMs: includeMs
Returns includeMs extends unknown
? | `${bigint}:${bigint}:${bigint} AM`
| `${bigint}:${bigint}:${bigint} PM`
: includeMs extends false
? | `${bigint}:${bigint}:${bigint} AM`
| `${bigint}:${bigint}:${bigint} PM`
: | `${bigint}:${bigint}:${bigint}.${bigint} AM`
| `${bigint}:${bigint}:${bigint}.${bigint} PM`
Formats a date object to a time string formatted as 12:37:01 PM, or if includeMs is set to true, 12:37:01.572 PM.