https://github.com/stephenhebert/datetime-iso8601
https://github.com/stephenhebert/datetime-iso8601
Last synced: 8 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/stephenhebert/datetime-iso8601
- Owner: stephenhebert
- Created: 2025-06-11T04:22:47.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2025-06-11T04:26:38.000Z (about 1 year ago)
- Last Synced: 2025-06-11T05:29:04.033Z (about 1 year ago)
- Language: TypeScript
- Homepage:
- Size: 45.9 KB
- Stars: 0
- Watchers: 0
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# datetime-iso8601
A lightweight TypeScript library for parsing, manipulating, and formatting ISO8601 date-time strings with time zone support.
## Features
- Parse ISO8601 date-time strings
- Manipulate date and time components
- Convert between time zones (IANA and UTC offset)
- Format date-time as ISO8601 strings
- Extract individual date/time components (e.g., weekday)
## Installation
```sh
npm install @stephenhebert/datetime-iso8601
```
## Usage
```typescript
import { DateTimeIso8601 } from '@stephenhebert/datetime-iso8601'
const dt = new DateTimeIso8601('2024-06-01T12:34:56+00:00')
// Get all components
console.log(dt.get())
// Get a specific component
console.log(dt.get('year')) // 2024
// Convert to a different time zone
dt.tz('-05:00')
console.log(dt.toString()) // e.g. "2024-06-01T07:34:56-05:00"
// Update components
dt.update({ hour: 15, minute: 0 })
console.log(dt.toString()) // "2024-06-01T15:00:56-05:00"
```
## API
### `class DateTimeIso8601`
#### `constructor(isoString: string)`
Creates a new instance from an ISO8601 string.
#### `get(key?: string)`
Returns all parsed components or a specific component.
- `year`, `month`, `day`, `hour`, `minute`, `second`, `tzOffsetHour`, `tzOffsetMinute`, `date`, `time`, `tzOffset`, `weekday`, `weekdayIndex`
#### `tz(tzOffset: string): this`
Converts the date-time to the specified time zone offset (e.g., `'+00:00'`, `'-05:00'`).
#### `update(newComponents: Partial, relative = false): this`
Updates date-time components. If `relative` is `true`, adds values to current components.
#### `toString(): string`
Returns the ISO8601 string representation.
## License
MIT