Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/itemconsulting/lib-xp-time
TS library for Java Time
https://github.com/itemconsulting/lib-xp-time
Last synced: about 2 months ago
JSON representation
TS library for Java Time
- Host: GitHub
- URL: https://github.com/itemconsulting/lib-xp-time
- Owner: ItemConsulting
- License: mit
- Created: 2023-01-30T13:48:17.000Z (almost 2 years ago)
- Default Branch: main
- Last Pushed: 2024-03-04T11:01:01.000Z (10 months ago)
- Last Synced: 2024-03-05T12:06:28.291Z (10 months ago)
- Language: JavaScript
- Size: 618 KB
- Stars: 2
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Time library for Enonic XP
This library enables the usage of classes from the [`java.time`](https://docs.oracle.com/en/java/javase/11/docs/api/java.base/java/time/package-summary.html) package from Enonic XP application code.
Other JavaScript-based time libraries like _Moment.js_ or _date-fns_ will negatively impact your bundle size and build time. This library is only a **thin TypeScript-wrapper** around the excellent core `java.time` library already present in your system!
[](https://jitpack.io/#no.item/lib-xp-time)
## Installation
To install this library you need to add a new dependency to your app's build.gradle file.
### Gradle
```groovy
repositories {
maven { url 'https://jitpack.io' }
}
dependencies {
include "no.item:lib-xp-time:1.0.3"
}
```
### TypeScript
To update the version of *enonic-types* in *package.json* using npm, run the following command:
```bash
npm install --save-dev @item-enonic-types/lib-time
```
You can add the following changes to your *tsconfig.json* to get TypeScript-support.
```diff
{
"compilerOptions": {
+ "baseUrl": "./",
+ "paths": {
+ "/lib/xp/*": ["./node_modules/@enonic-types/lib-*"],
+ "/lib/*": [ "./node_modules/@item-enonic-types/lib-*" ,"./src/main/resources/lib/*"],
+ }
}
}
```
### Usage
You can import `java.time` and `java.time.format` classes from `"/lib/time"`.
*Example of date math on a `LocalDateTime` using `"/lib/time"`:*
```typescript
import { LocalDateTime, DateTimeFormatter } from "/lib/time";
const today = LocalDateTime.parse("2023-02-21T12:15:30");
const formatter = DateTimeFormatter.ofPattern("dd.MM hh:mm")
const inThreeWeeksStr = today
.plusWeeks(3)
.format(formatter);
// inThreeWeeksStr = "14.03 12:15"
```
*Example of doing time math using a `ZonedDateTime`:*
```typescript
import { ZonedDateTime } from "/lib/time";
const date = ZonedDateTime.parse("2023-02-21T12:15:30+01:00");
const fiftyMinutesAgo = date.minusMinutes(50);
const time = fiftyMinutesAgo.toLocalTime();
// time = "11:25:30"
```
*This library also exposes a utility function `formatDate()` to simply format a date:*
```typescript
import { formatDate } from "/lib/time";
const today = formatDate({
date: "2023-02-21",
pattern: "dd-MM-yyyy",
locale: "no"
});
// today = "21-02-2023"
```
*Use `formatDate()` with a given timezoneId*
```typescript
import { formatDate } from "/lib/time";
const today = formatDate({
date: "2023-02-21",
pattern: "dd-MM-yyyy",
locale: "no",
timezoneId: "Europe/Oslo"
});
// today = "21-02-2023"
```
*Example of using `Locale` in formatting a `LocalDateTime` and get a normalized timestamp :*
```typescript
import { LocalDateTime, DateTimeFormatter, Locale } from "/lib/time";
const today = LocalDateTime.parse("2023-02-21T12:15:30");
const formatter = DateTimeFormatter.ofPattern("EEEE d. MMMM yyyy hh:mm:ss", new Locale("no"));
const time = today.format(formatter);
// time = "tirsdag 21. februar 2023 12:15:30"
```
### Constants exposed from `"/lib/time"`
The following classes is exposed/exported from `"/lib/time"`:
* `DateTimeFormatter`
* `DayOfWeek`
* `Instant`
* `LocalDate`
* `LocalDateTime`
* `Locale`
* `LocalTime`
* `Month`
* `OffsetDateTime`
* `OffsetTime`
* `ZonedDateTime`
* `ZoneId`
* `ZoneOffset`
### Building
To build the project run the following code
```bash
./gradlew build
```
### Deploy locally
Deploy locally for testing purposes:
```bash
./gradlew publishToMavenLocal
```
## Deploy to Jitpack
Go to the [Jitpack page for lib-xp-time](https://jitpack.io/#no.item/lib-xp-time) to deploy from GitHub (after
[creating a new versioned release](https://github.com/ItemConsulting/lib-xp-time/releases/new)).