@herowcode/utils 1.1.9 → 1.1.10

package/README.md

@@ -118,6 +118,17 @@ Converts a Date to a Dayjs object in UTC.
 getDateInUTC(new Date());
 ```
 
+#### `getRelativeTime(date: ConfigType, dateNow?: Dayjs | ConfigType): string`
+Returns a human-readable relative time string (for example: "a few seconds ago", "in 2 days"). It accepts any input supported by dayjs (Date, string, number) and an optional `dateNow` parameter to compute the difference against a custom reference time.
+
+```typescript
+// Using a fixed reference
+getRelativeTime('2025-09-15T11:59:00Z', dayjs('2025-09-15T12:00:00Z')) // "a minute ago"
+
+// Or with default reference (now)
+getRelativeTime(new Date()) // "a few seconds ago"
+```
+
 #### `parseTimeSpent(initialDate: string | Date, finalDate: string | Date, locale?: string, options?: { format?: 'verbose' | 'compact'; minimal?: boolean }): ITimeSpent`
 
 Retorna um objeto com a decomposição do tempo entre duas datas e uma string formatada. Estrutura retornada (ITimeSpent):

package/dist/cjs/date/get-relative-time.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigType } from "dayjs";
+export declare function getRelativeTime(date: ConfigType, dateNow?: import("dayjs").Dayjs): string;
+//# sourceMappingURL=get-relative-time.d.ts.map

package/dist/cjs/date/get-relative-time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-relative-time.d.ts","sourceRoot":"","sources":["../../../src/date/get-relative-time.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAGvC,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,wBAAU,GAAG,MAAM,CAE3E"}

package/dist/cjs/date/get-relative-time.js

@@ -0,0 +1,8 @@
+"use strict";
+Object.defineProperty(exports, "__esModule", { value: true });
+exports.getRelativeTime = getRelativeTime;
+const dayjs_1 = require("./dayjs");
+function getRelativeTime(date, dateNow = (0, dayjs_1.dayjs)()) {
+    return (0, dayjs_1.dayjs)(date).from(dateNow);
+}
+//# sourceMappingURL=get-relative-time.js.map

package/dist/cjs/date/get-relative-time.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-relative-time.js","sourceRoot":"","sources":["../../../src/date/get-relative-time.ts"],"names":[],"mappings":";;AAGA,0CAEC;AAJD,mCAA+B;AAE/B,SAAgB,eAAe,CAAC,IAAgB,EAAE,OAAO,GAAG,IAAA,aAAK,GAAE;IACjE,OAAO,IAAA,aAAK,EAAC,IAAI,CAAC,CAAC,IAAI,CAAC,OAAO,CAAC,CAAA;AAClC,CAAC"}

package/dist/cjs/date/index.d.ts

@@ -3,5 +3,6 @@ export * from "./fix-timezone-offset";
 export * from "./format-date";
 export * from "./get-current-date-in-utc";
 export * from "./get-date-in-utc";
+export * from "./get-relative-time";
 export * from "./parse-time-spent";
 //# sourceMappingURL=index.d.ts.map

package/dist/cjs/date/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/date/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../../src/date/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA"}

package/dist/cjs/date/index.js

@@ -19,5 +19,6 @@ __exportStar(require("./fix-timezone-offset"), exports);
 __exportStar(require("./format-date"), exports);
 __exportStar(require("./get-current-date-in-utc"), exports);
 __exportStar(require("./get-date-in-utc"), exports);
+__exportStar(require("./get-relative-time"), exports);
 __exportStar(require("./parse-time-spent"), exports);
 //# sourceMappingURL=index.js.map

package/dist/cjs/date/index.js.map

@@ -1 +1 @@
-{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/date/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,wDAAqC;AACrC,gDAA6B;AAC7B,4DAAyC;AACzC,oDAAiC;AACjC,qDAAkC"}
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../../src/date/index.ts"],"names":[],"mappings":";;;;;;;;;;;;;;;;AAAA,0CAAuB;AACvB,wDAAqC;AACrC,gDAA6B;AAC7B,4DAAyC;AACzC,oDAAiC;AACjC,sDAAmC;AACnC,qDAAkC"}

package/dist/date/get-relative-time.d.ts

@@ -0,0 +1,3 @@
+import type { ConfigType } from "dayjs";
+export declare function getRelativeTime(date: ConfigType, dateNow?: import("dayjs").Dayjs): string;
+//# sourceMappingURL=get-relative-time.d.ts.map

package/dist/date/get-relative-time.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"get-relative-time.d.ts","sourceRoot":"","sources":["../../src/date/get-relative-time.ts"],"names":[],"mappings":"AAAA,OAAO,KAAK,EAAE,UAAU,EAAE,MAAM,OAAO,CAAA;AAGvC,wBAAgB,eAAe,CAAC,IAAI,EAAE,UAAU,EAAE,OAAO,wBAAU,GAAG,MAAM,CAE3E"}

package/dist/date/index.d.ts

@@ -3,5 +3,6 @@ export * from "./fix-timezone-offset";
 export * from "./format-date";
 export * from "./get-current-date-in-utc";
 export * from "./get-date-in-utc";
+export * from "./get-relative-time";
 export * from "./parse-time-spent";
 //# sourceMappingURL=index.d.ts.map

package/dist/date/index.d.ts.map

@@ -1 +1 @@
-{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/date/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,oBAAoB,CAAA"}
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/date/index.ts"],"names":[],"mappings":"AAAA,cAAc,SAAS,CAAA;AACvB,cAAc,uBAAuB,CAAA;AACrC,cAAc,eAAe,CAAA;AAC7B,cAAc,2BAA2B,CAAA;AACzC,cAAc,mBAAmB,CAAA;AACjC,cAAc,qBAAqB,CAAA;AACnC,cAAc,oBAAoB,CAAA"}

package/dist/esm/date/get-relative-time.js

@@ -0,0 +1,4 @@
+import { dayjs } from "./dayjs.js";
+export function getRelativeTime(date, dateNow = dayjs()) {
+    return dayjs(date).from(dateNow);
+}

package/dist/esm/date/index.js

@@ -3,4 +3,5 @@ export * from "./fix-timezone-offset.js";
 export * from "./format-date.js";
 export * from "./get-current-date-in-utc.js";
 export * from "./get-date-in-utc.js";
+export * from "./get-relative-time.js";
 export * from "./parse-time-spent.js";

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@herowcode/utils",
-  "version": "1.1.9",
+  "version": "1.1.10",
   "description": "A lightweight collection of utility functions for everyday JavaScript/TypeScript development",
   "main": "dist/cjs/index.js",
   "module": "dist/esm/index.js",