@item-enonic-types/lib-time 0.1.2 → 1.0.2

package/README.md

@@ -19,7 +19,7 @@ repositories {
 }
 
 dependencies {
-  include "no.item:lib-xp-time:0.1.0"
+  include "no.item:lib-xp-time:1.0.0"
 }
 ```
 
@@ -54,9 +54,11 @@ You can import `java.time` and  `java.time.format` classes from `"/lib/time"`.
 import { LocalDateTime, DateTimeFormatter } from "/lib/time";
 
 const today = LocalDateTime.parse("2023-02-21T12:15:30");
-const inThreeWeeks = today.plusWeeks(3);
-const dateStr = inThreeWeeks.format(DateTimeFormatter.ofPattern("dd-MM-yyyy hh:mm:ss"));
-// dateStr = "14-03-2023 12: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`:*
@@ -75,13 +77,35 @@ const time = fiftyMinutesAgo.toLocalTime();
 ```typescript
 import { formatDate } from "/lib/time";
 
-const today = t.formatDate({
+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"`:

package/day-of-week.d.ts

@@ -6,8 +6,12 @@ export declare const DayOfWeek: DayOfWeekConstructor;
 export type WeekDayNumber = 1 | 2 | 3 | 4 | 5 | 6 | 7;
 export interface DayOfWeekConstructor {
     of(dayOfWeek: WeekDayNumber): DayOfWeek;
+    valueOf(name: string): DayOfWeek;
+    values(): DayOfWeek[];
 }
 export interface DayOfWeek {
     getValue(): WeekDayNumber;
+    minus(days: number): DayOfWeek;
+    plus(days: number): DayOfWeek;
     toString(): string;
 }

package/index.d.ts

@@ -19,15 +19,17 @@ export { ZoneOffset } from "/lib/time/zone-offset";
  * @param pattern The shape of the output string
  * @param locale The locale of the country you are formatting to
  */
-export declare function formatDate({ date, pattern, locale }: FormatDateParams): string;
-export declare function formatDate({ date, pattern, locale }: FormatDateParamsAllowNullable): string | undefined;
+export declare function formatDate({ date, pattern, locale, timezoneId }: FormatDateParams): string;
+export declare function formatDate({ date, pattern, locale, timezoneId }: FormatDateParamsAllowNullable): string | undefined;
 export interface FormatDateParams {
     date: string | Date;
     pattern: string;
     locale?: string | undefined;
+    timezoneId?: string | undefined;
 }
 export interface FormatDateParamsAllowNullable {
     date: string | Date | undefined | null;
     pattern: string;
     locale?: string | undefined;
+    timezoneId?: string | undefined;
 }

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@item-enonic-types/lib-time",
-  "version": "0.1.2",
+  "version": "1.0.2",
   "description": "Type definitions for lib-time",
   "license": "MIT",
   "files": [
@@ -14,7 +14,7 @@
     "dist:server": "cross-env NODE_ENV=production webpack --config webpack.server.config.js --color",
     "dist": "run-p -c dist:*",
     "lint": "eslint --fix 'src/**/*.ts'",
-    "prepublishOnly": "tsc --declarationDir build/types --emitDeclarationOnly true --declaration true && cp -r ./build/types/* .",
+    "prepublishOnly": "tsc --declarationDir build/types --emitDeclarationOnly true --declaration true && cp -r ./build/types/src/main/resources/lib/time/* .",
     "postpublish": "rm ./*.d.ts && rm -r ./format"
   },
   "devDependencies": {

package/tsconfig.json

@@ -17,9 +17,6 @@
     "declaration": true,
     "declarationDir": "build/types"
   },
-  "include": [
-    "./src/main/resources/**/*"
-  ],
   "exclude": [
     "./build/*",
   ],