@pawells/typescript-common 1.0.0

package/build/time/elapsed-time/types.d.ts

@@ -0,0 +1,150 @@
+/**
+ * Represents a time unit and its corresponding value.
+ */
+export interface ITimeUnitValue {
+    /** The time unit type (week, day, hour, minute, second, millisecond) */
+    unit: TTimeUnit;
+    /** The numeric value for this time unit */
+    value: number;
+}
+/**
+ * Configuration options for formatting elapsed time values.
+ */
+export interface ITimeElapsedFormatOptions {
+    /** How to format negative values: 'Empty' (no indicator), 'NegativeSign' (prefix with -), 'Parenthesis' (wrap in parentheses), or 'Brackets' (wrap in brackets) */
+    negativeValueFormat?: 'Empty' | 'NegativeSign' | 'Parenthesis' | 'Brackets' | undefined;
+    /** Show zero value units in formatter output (default: false) */
+    showZeroValues?: boolean | undefined;
+    /** Maximum number of units to include in formatter output (default: unlimited) */
+    maxUnits?: number | undefined;
+    /** Custom unit labels for formatter */
+    unitLabels?: {
+        week?: string | ((_value: number) => string) | undefined;
+        day?: string | ((_value: number) => string) | undefined;
+        hour?: string | ((_value: number) => string) | undefined;
+        minute?: string | ((_value: number) => string) | undefined;
+        second?: string | ((_value: number) => string) | undefined;
+        millisecond?: string | ((_value: number) => string) | undefined;
+    } | undefined;
+}
+/**
+ * Predefined time elapsed format styles.
+ */
+export type TTimeElapsedFormats = 'concise' | 'short' | 'medium' | 'long' | 'mostSignificant' | 'time' | 'timeWithSeconds';
+/**
+ * Available time unit types for formatting elapsed time values.
+ */
+export type TTimeUnit = 'week' | 'day' | 'hour' | 'minute' | 'second' | 'millisecond';
+/**
+ * Unit label as a string
+ */
+export type TUnitLabelString = string;
+/**
+ * Unit label as a function that handles pluralization
+ * @param value - The numeric value to determine singular/plural
+ * @returns The appropriate label string
+ */
+export type TUnitLabelFunction = (value: number) => string;
+/**
+ * Unit label can be either a string or a function
+ */
+export type TUnitLabel = TUnitLabelString | TUnitLabelFunction;
+/**
+ * Map of time units to their labels
+ */
+export interface IUnitLabelMap {
+    /** Label for milliseconds */
+    millisecond: TUnitLabel;
+    /** Label for seconds */
+    second: TUnitLabel;
+    /** Label for minutes */
+    minute: TUnitLabel;
+    /** Label for hours */
+    hour: TUnitLabel;
+    /** Label for days */
+    day: TUnitLabel;
+    /** Label for weeks */
+    week: TUnitLabel;
+}
+/**
+ * Concise format style with single-character labels
+ */
+export interface IConciseUnitLabels extends IUnitLabelMap {
+    millisecond: 'ms';
+    second: 's';
+    minute: 'm';
+    hour: 'h';
+    day: 'd';
+    week: 'w';
+}
+/**
+ * Long format style with full words and pluralization
+ */
+export interface ILongUnitLabels extends IUnitLabelMap {
+    millisecond: TUnitLabelFunction;
+    second: TUnitLabelFunction;
+    minute: TUnitLabelFunction;
+    hour: TUnitLabelFunction;
+    day: TUnitLabelFunction;
+    week: TUnitLabelFunction;
+}
+/**
+ * Medium format style with abbreviated words
+ */
+export interface IMediumUnitLabels extends IUnitLabelMap {
+    millisecond: 'ms';
+    second: 'sec';
+    minute: 'min';
+    hour: 'hour';
+    day: 'day';
+    week: 'week';
+}
+/**
+ * Short format style with short abbreviations
+ */
+export interface IShortUnitLabels extends IUnitLabelMap {
+    millisecond: 'ms';
+    second: 'sec';
+    minute: 'min';
+    hour: 'hr';
+    day: 'd';
+    week: 'wk';
+}
+/**
+ * Complete set of default unit labels for all formatting styles
+ */
+export interface IDefaultUnitLabels {
+    concise: IConciseUnitLabels;
+    long: ILongUnitLabels;
+    medium: IMediumUnitLabels;
+    short: IShortUnitLabels;
+}
+/**
+ * Configuration options for elapsed time formatting
+ */
+export interface IFormatConfig {
+    /** Maximum number of units to display */
+    maxUnits?: number;
+    /** Unit labels to use for formatting */
+    unitLabels: Partial<IUnitLabelMap>;
+}
+/**
+ * Predefined formatter styles
+ */
+export interface IFormats {
+    /** Format like "1h 30m 45s" */
+    concise: IFormatConfig;
+    /** Format like "1 hour 30 minutes 45 seconds" with proper pluralization */
+    long: IFormatConfig;
+    /** Format like "1 hour 30 min 45 sec" */
+    medium: IFormatConfig;
+    /** Format showing only the most significant 2 units */
+    mostSignificant: IFormatConfig;
+    /** Format like "1hr 30min 45sec" */
+    short: IFormatConfig;
+    /** Format showing only hours and minutes like "1:30" */
+    time: IFormatConfig;
+    /** Format showing hours, minutes and seconds like "1:30:45" */
+    timeWithSeconds: IFormatConfig;
+}
+//# sourceMappingURL=types.d.ts.map

package/build/time/elapsed-time/types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.d.ts","sourceRoot":"","sources":["../../../src/time/elapsed-time/types.ts"],"names":[],"mappings":"AAAA;;GAEG;AACH,MAAM,WAAW,cAAc;IAC9B,wEAAwE;IACxE,IAAI,EAAE,SAAS,CAAC;IAChB,2CAA2C;IAC3C,KAAK,EAAE,MAAM,CAAA;CACb;AAED;;GAEG;AACH,MAAM,WAAW,yBAAyB;IACzC,mKAAmK;IACnK,mBAAmB,CAAC,EAAE,OAAO,GAAG,cAAc,GAAG,aAAa,GAAG,UAAU,GAAG,SAAS,CAAC;IACxF,iEAAiE;IACjE,cAAc,CAAC,EAAE,OAAO,GAAG,SAAS,CAAC;IACrC,kFAAkF;IAClF,QAAQ,CAAC,EAAE,MAAM,GAAG,SAAS,CAAC;IAC9B,uCAAuC;IACvC,UAAU,CAAC,EAAE;QACZ,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QACzD,GAAG,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QACxD,IAAI,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QACzD,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QAC3D,MAAM,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;QAC3D,WAAW,CAAC,EAAE,MAAM,GAAG,CAAC,CAAC,MAAM,EAAE,MAAM,KAAK,MAAM,CAAC,GAAG,SAAS,CAAC;KAChE,GAAG,SAAS,CAAC;CACd;AAED;;GAEG;AACH,MAAM,MAAM,mBAAmB,GAAG,SAAS,GAAG,OAAO,GAAG,QAAQ,GAAG,MAAM,GAAG,iBAAiB,GAAG,MAAM,GAAG,iBAAiB,CAAC;AAE3H;;GAEG;AACH,MAAM,MAAM,SAAS,GAAG,MAAM,GAAG,KAAK,GAAG,MAAM,GAAG,QAAQ,GAAG,QAAQ,GAAG,aAAa,CAAC;AAEtF;;GAEG;AACH,MAAM,MAAM,gBAAgB,GAAG,MAAM,CAAC;AAEtC;;;;GAIG;AACH,MAAM,MAAM,kBAAkB,GAAG,CAAC,KAAK,EAAE,MAAM,KAAK,MAAM,CAAC;AAE3D;;GAEG;AACH,MAAM,MAAM,UAAU,GAAG,gBAAgB,GAAG,kBAAkB,CAAC;AAE/D;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,6BAA6B;IAC7B,WAAW,EAAE,UAAU,CAAC;IACxB,wBAAwB;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,wBAAwB;IACxB,MAAM,EAAE,UAAU,CAAC;IACnB,sBAAsB;IACtB,IAAI,EAAE,UAAU,CAAC;IACjB,qBAAqB;IACrB,GAAG,EAAE,UAAU,CAAC;IAChB,sBAAsB;IACtB,IAAI,EAAE,UAAU,CAAC;CACjB;AAED;;GAEG;AACH,MAAM,WAAW,kBAAmB,SAAQ,aAAa;IACxD,WAAW,EAAE,IAAI,CAAC;IAClB,MAAM,EAAE,GAAG,CAAC;IACZ,MAAM,EAAE,GAAG,CAAC;IACZ,IAAI,EAAE,GAAG,CAAC;IACV,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,GAAG,CAAC;CACV;AAED;;GAEG;AACH,MAAM,WAAW,eAAgB,SAAQ,aAAa;IACrD,WAAW,EAAE,kBAAkB,CAAC;IAChC,MAAM,EAAE,kBAAkB,CAAC;IAC3B,MAAM,EAAE,kBAAkB,CAAC;IAC3B,IAAI,EAAE,kBAAkB,CAAC;IACzB,GAAG,EAAE,kBAAkB,CAAC;IACxB,IAAI,EAAE,kBAAkB,CAAC;CACzB;AAED;;GAEG;AACH,MAAM,WAAW,iBAAkB,SAAQ,aAAa;IACvD,WAAW,EAAE,IAAI,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;IACd,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,MAAM,CAAC;IACb,GAAG,EAAE,KAAK,CAAC;IACX,IAAI,EAAE,MAAM,CAAC;CACb;AAED;;GAEG;AACH,MAAM,WAAW,gBAAiB,SAAQ,aAAa;IACtD,WAAW,EAAE,IAAI,CAAC;IAClB,MAAM,EAAE,KAAK,CAAC;IACd,MAAM,EAAE,KAAK,CAAC;IACd,IAAI,EAAE,IAAI,CAAC;IACX,GAAG,EAAE,GAAG,CAAC;IACT,IAAI,EAAE,IAAI,CAAC;CACX;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IAClC,OAAO,EAAE,kBAAkB,CAAC;IAC5B,IAAI,EAAE,eAAe,CAAC;IACtB,MAAM,EAAE,iBAAiB,CAAC;IAC1B,KAAK,EAAE,gBAAgB,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,WAAW,aAAa;IAC7B,yCAAyC;IACzC,QAAQ,CAAC,EAAE,MAAM,CAAC;IAClB,wCAAwC;IACxC,UAAU,EAAE,OAAO,CAAC,aAAa,CAAC,CAAC;CACnC;AAED;;GAEG;AACH,MAAM,WAAW,QAAQ;IACxB,+BAA+B;IAC/B,OAAO,EAAE,aAAa,CAAC;IACvB,2EAA2E;IAC3E,IAAI,EAAE,aAAa,CAAC;IACpB,yCAAyC;IACzC,MAAM,EAAE,aAAa,CAAC;IACtB,uDAAuD;IACvD,eAAe,EAAE,aAAa,CAAC;IAC/B,oCAAoC;IACpC,KAAK,EAAE,aAAa,CAAC;IACrB,wDAAwD;IACxD,IAAI,EAAE,aAAa,CAAC;IACpB,+DAA+D;IAC/D,eAAe,EAAE,aAAa,CAAC;CAC/B"}

package/build/time/elapsed-time/types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=types.js.map

package/build/time/elapsed-time/types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"types.js","sourceRoot":"","sources":["../../../src/time/elapsed-time/types.ts"],"names":[],"mappings":""}

package/build/time/elapsed-time/utils.d.ts

@@ -0,0 +1,18 @@
+import { ITimeElapsedFormatOptions } from './types.js';
+/**
+ * Apply default options to format options object.
+ * Merges user-provided options with sensible defaults for time formatting.
+ *
+ * @param options - Partial formatting options of type ITimeElapsedFormatOptions provided by the user
+ * @returns Complete formatting options with defaults applied
+ *
+ * @example
+ * ```typescript
+ * const userOptions = { showZeroValues: true };
+ * const complete = ApplyDefaultOptions(userOptions);
+ * // Result: { negativeValueFormat: 'NegativeSign', showZeroValues: true, maxUnits: undefined, unitLabels: undefined }
+ * ```
+ */
+declare function ApplyDefaultOptions(options: Partial<ITimeElapsedFormatOptions>): ITimeElapsedFormatOptions;
+export { ApplyDefaultOptions };
+//# sourceMappingURL=utils.d.ts.map

package/build/time/elapsed-time/utils.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.d.ts","sourceRoot":"","sources":["../../../src/time/elapsed-time/utils.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,yBAAyB,EAAE,MAAM,YAAY,CAAC;AAEvD;;;;;;;;;;;;;GAaG;AACH,iBAAS,mBAAmB,CAAC,OAAO,EAAE,OAAO,CAAC,yBAAyB,CAAC,GAAG,yBAAyB,CAOnG;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/build/time/elapsed-time/utils.js

@@ -0,0 +1,24 @@
+/**
+ * Apply default options to format options object.
+ * Merges user-provided options with sensible defaults for time formatting.
+ *
+ * @param options - Partial formatting options of type ITimeElapsedFormatOptions provided by the user
+ * @returns Complete formatting options with defaults applied
+ *
+ * @example
+ * ```typescript
+ * const userOptions = { showZeroValues: true };
+ * const complete = ApplyDefaultOptions(userOptions);
+ * // Result: { negativeValueFormat: 'NegativeSign', showZeroValues: true, maxUnits: undefined, unitLabels: undefined }
+ * ```
+ */
+function ApplyDefaultOptions(options) {
+    return {
+        maxUnits: options.maxUnits,
+        negativeValueFormat: options.negativeValueFormat ?? 'NegativeSign',
+        showZeroValues: options.showZeroValues ?? false,
+        unitLabels: options.unitLabels,
+    };
+}
+export { ApplyDefaultOptions };
+//# sourceMappingURL=utils.js.map

package/build/time/elapsed-time/utils.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"utils.js","sourceRoot":"","sources":["../../../src/time/elapsed-time/utils.ts"],"names":[],"mappings":"AAEA;;;;;;;;;;;;;GAaG;AACH,SAAS,mBAAmB,CAAC,OAA2C;IACvE,OAAO;QACN,QAAQ,EAAE,OAAO,CAAC,QAAQ;QAC1B,mBAAmB,EAAE,OAAO,CAAC,mBAAmB,IAAI,cAAc;QAClE,cAAc,EAAE,OAAO,CAAC,cAAc,IAAI,KAAK;QAC/C,UAAU,EAAE,OAAO,CAAC,UAAU;KAC9B,CAAC;AACH,CAAC;AAED,OAAO,EAAE,mBAAmB,EAAE,CAAC"}

package/build/time/index.d.ts

@@ -0,0 +1,18 @@
+/**
+ * Time measurement utilities.
+ *
+ * Provides the {@link ElapsedTime} value-object for representing and formatting
+ * durations, and the {@link Stopwatch} class for recording timestamped events
+ * such as starts, stops, pauses, resumes, and laps.
+ *
+ * @module time
+ */
+export * from './elapsed-time/elapsed-time.js';
+export * from './elapsed-time/types.js';
+export * from './elapsed-time/constants.js';
+export * from './elapsed-time/utils.js';
+export * from './stopwatch/stopwatch.js';
+export * from './stopwatch/entry.js';
+export * from './stopwatch/entry-types.js';
+export type { TUnitLabel, TUnitLabelString, TUnitLabelFunction, IUnitLabelMap, IConciseUnitLabels, ILongUnitLabels, IMediumUnitLabels, IShortUnitLabels, IDefaultUnitLabels, IFormatConfig, IFormats, } from './elapsed-time/types.js';
+//# sourceMappingURL=index.d.ts.map

package/build/time/index.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.d.ts","sourceRoot":"","sources":["../../src/time/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC;AAE3C,YAAY,EACX,UAAU,EACV,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,kBAAkB,EAClB,eAAe,EACf,iBAAiB,EACjB,gBAAgB,EAChB,kBAAkB,EAClB,aAAa,EACb,QAAQ,GACR,MAAM,yBAAyB,CAAC"}

package/build/time/index.js

@@ -0,0 +1,17 @@
+/**
+ * Time measurement utilities.
+ *
+ * Provides the {@link ElapsedTime} value-object for representing and formatting
+ * durations, and the {@link Stopwatch} class for recording timestamped events
+ * such as starts, stops, pauses, resumes, and laps.
+ *
+ * @module time
+ */
+export * from './elapsed-time/elapsed-time.js';
+export * from './elapsed-time/types.js';
+export * from './elapsed-time/constants.js';
+export * from './elapsed-time/utils.js';
+export * from './stopwatch/stopwatch.js';
+export * from './stopwatch/entry.js';
+export * from './stopwatch/entry-types.js';
+//# sourceMappingURL=index.js.map

package/build/time/index.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"index.js","sourceRoot":"","sources":["../../src/time/index.ts"],"names":[],"mappings":"AAAA;;;;;;;;GAQG;AAEH,cAAc,gCAAgC,CAAC;AAC/C,cAAc,yBAAyB,CAAC;AACxC,cAAc,6BAA6B,CAAC;AAC5C,cAAc,yBAAyB,CAAC;AACxC,cAAc,0BAA0B,CAAC;AACzC,cAAc,sBAAsB,CAAC;AACrC,cAAc,4BAA4B,CAAC"}

package/build/time/stopwatch/entry-types.d.ts

@@ -0,0 +1,13 @@
+import { ElapsedTime } from '../elapsed-time/elapsed-time.js';
+/**
+ * Represents a single timestamp entry recorded by the stopwatch.
+ */
+export interface IStopwatchEntryData {
+    /** The timestamp when this entry was recorded (milliseconds since epoch) */
+    timestamp: number;
+    /** The elapsed time since the previous entry */
+    elapsed: ElapsedTime;
+    /** The total elapsed time since the stopwatch was first started */
+    elapsedTotal: ElapsedTime;
+}
+//# sourceMappingURL=entry-types.d.ts.map

package/build/time/stopwatch/entry-types.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry-types.d.ts","sourceRoot":"","sources":["../../../src/time/stopwatch/entry-types.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAE9D;;GAEG;AACH,MAAM,WAAW,mBAAmB;IACnC,4EAA4E;IAC5E,SAAS,EAAE,MAAM,CAAC;IAClB,gDAAgD;IAChD,OAAO,EAAE,WAAW,CAAC;IACrB,mEAAmE;IACnE,YAAY,EAAE,WAAW,CAAC;CAC1B"}

package/build/time/stopwatch/entry-types.js

@@ -0,0 +1,2 @@
+export {};
+//# sourceMappingURL=entry-types.js.map

package/build/time/stopwatch/entry-types.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry-types.js","sourceRoot":"","sources":["../../../src/time/stopwatch/entry-types.ts"],"names":[],"mappings":""}

package/build/time/stopwatch/entry.d.ts

@@ -0,0 +1,80 @@
+import { ElapsedTime } from '../elapsed-time/elapsed-time.js';
+import { Stopwatch } from './stopwatch.js';
+/**
+ * Represents a single timestamped entry recorded by a {@link Stopwatch}.
+ *
+ * Each entry captures the exact moment in time (milliseconds since epoch) at
+ * which a stopwatch event occurred — such as a start, stop, pause, resume, or
+ * lap click. It exposes both the interval elapsed since the previous entry and
+ * the total elapsed time since the stopwatch was first started.
+ *
+ * @example
+ * ```typescript
+ * const sw = new Stopwatch(true);
+ * // ... some work ...
+ * const entry = sw.Stop();
+ * console.log(entry?.timestamp);              // e.g. 1708512000000
+ * console.log(entry?.Elapsed.Format());       // e.g. "250ms"
+ * console.log(entry?.ElapsedTotal.Format());  // e.g. "1s 250ms"
+ * ```
+ */
+export declare class StopwatchEntry {
+    private readonly _timestamp;
+    private readonly _stopwatch;
+    private readonly _index;
+    /**
+     * Creates a new stopwatch entry.
+     *
+     * @param _timestamp - The Unix timestamp in milliseconds when this entry was recorded.
+     * @param stopwatch - The parent {@link Stopwatch} instance, used to compute
+     *   relative elapsed times. If omitted the entry is standalone, and `Elapsed`
+     *   and `ElapsedTotal` will always return zero.
+     * @param index - Zero-based position of this entry within the stopwatch's
+     *   internal times array. Used to locate the preceding entry for lap calculations.
+     */
+    constructor(_timestamp: number, stopwatch?: Stopwatch, index?: number);
+    /**
+     * The Unix timestamp (milliseconds since epoch) when this entry was recorded.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * const entry = sw.Stop()!;
+     * console.log(new Date(entry.timestamp).toISOString());
+     * ```
+     */
+    get timestamp(): number;
+    /**
+     * The elapsed time between this entry and the immediately preceding entry.
+     *
+     * Returns {@link ElapsedTime} with a value of `0` if:
+     * - This is the first entry in the stopwatch (no previous entry exists), or
+     * - The entry was created without an associated stopwatch.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * // ... 300 ms of work ...
+     * const lap1 = sw.Lap();
+     * console.log(lap1.Format()); // "300ms"
+     * ```
+     */
+    get Elapsed(): ElapsedTime;
+    /**
+     * The total elapsed time from the very first entry of the parent stopwatch
+     * up to and including this entry.
+     *
+     * Returns {@link ElapsedTime} with a value of `0` if this entry was created
+     * without an associated stopwatch or if the stopwatch has no recorded entries.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * // ... 1200 ms of work ...
+     * const stopEntry = sw.Stop()!;
+     * console.log(stopEntry.ElapsedTotal.Format('LONG')); // "1 second 200 milliseconds"
+     * ```
+     */
+    get ElapsedTotal(): ElapsedTime;
+}
+//# sourceMappingURL=entry.d.ts.map

package/build/time/stopwatch/entry.d.ts.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.d.ts","sourceRoot":"","sources":["../../../src/time/stopwatch/entry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAC9D,OAAO,EAAE,SAAS,EAAE,MAAM,gBAAgB,CAAC;AAE3C;;;;;;;;;;;;;;;;;GAiBG;AACH,qBAAa,cAAc;IAed,OAAO,CAAC,QAAQ,CAAC,UAAU;IAdvC,OAAO,CAAC,QAAQ,CAAC,UAAU,CAA0B;IAErD,OAAO,CAAC,QAAQ,CAAC,MAAM,CAAc;IAErC;;;;;;;;;OASG;gBAC0B,UAAU,EAAE,MAAM,EAAE,SAAS,CAAC,EAAE,SAAS,EAAE,KAAK,CAAC,EAAE,MAAM;IAOtF;;;;;;;;;OASG;IACH,IAAW,SAAS,IAAI,MAAM,CAE7B;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO,IAAI,WAAW,CAUhC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,YAAY,IAAI,WAAW,CAUrC;CACD"}

package/build/time/stopwatch/entry.js

@@ -0,0 +1,105 @@
+import { ElapsedTime } from '../elapsed-time/elapsed-time.js';
+/**
+ * Represents a single timestamped entry recorded by a {@link Stopwatch}.
+ *
+ * Each entry captures the exact moment in time (milliseconds since epoch) at
+ * which a stopwatch event occurred — such as a start, stop, pause, resume, or
+ * lap click. It exposes both the interval elapsed since the previous entry and
+ * the total elapsed time since the stopwatch was first started.
+ *
+ * @example
+ * ```typescript
+ * const sw = new Stopwatch(true);
+ * // ... some work ...
+ * const entry = sw.Stop();
+ * console.log(entry?.timestamp);              // e.g. 1708512000000
+ * console.log(entry?.Elapsed.Format());       // e.g. "250ms"
+ * console.log(entry?.ElapsedTotal.Format());  // e.g. "1s 250ms"
+ * ```
+ */
+export class StopwatchEntry {
+    _timestamp;
+    _stopwatch = null;
+    _index = -1;
+    /**
+     * Creates a new stopwatch entry.
+     *
+     * @param _timestamp - The Unix timestamp in milliseconds when this entry was recorded.
+     * @param stopwatch - The parent {@link Stopwatch} instance, used to compute
+     *   relative elapsed times. If omitted the entry is standalone, and `Elapsed`
+     *   and `ElapsedTotal` will always return zero.
+     * @param index - Zero-based position of this entry within the stopwatch's
+     *   internal times array. Used to locate the preceding entry for lap calculations.
+     */
+    constructor(_timestamp, stopwatch, index) {
+        this._timestamp = _timestamp;
+        if (stopwatch) {
+            this._stopwatch = stopwatch;
+            this._index = index ?? 0;
+        }
+    }
+    /**
+     * The Unix timestamp (milliseconds since epoch) when this entry was recorded.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * const entry = sw.Stop()!;
+     * console.log(new Date(entry.timestamp).toISOString());
+     * ```
+     */
+    get timestamp() {
+        return this._timestamp;
+    }
+    /**
+     * The elapsed time between this entry and the immediately preceding entry.
+     *
+     * Returns {@link ElapsedTime} with a value of `0` if:
+     * - This is the first entry in the stopwatch (no previous entry exists), or
+     * - The entry was created without an associated stopwatch.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * // ... 300 ms of work ...
+     * const lap1 = sw.Lap();
+     * console.log(lap1.Format()); // "300ms"
+     * ```
+     */
+    get Elapsed() {
+        if (!this._stopwatch || this._index <= 0) {
+            return new ElapsedTime(0);
+        }
+        const previousEntry = this._stopwatch.Times[this._index - 1];
+        if (!previousEntry) {
+            return new ElapsedTime(0);
+        }
+        return new ElapsedTime(this._timestamp - previousEntry.timestamp);
+    }
+    /**
+     * The total elapsed time from the very first entry of the parent stopwatch
+     * up to and including this entry.
+     *
+     * Returns {@link ElapsedTime} with a value of `0` if this entry was created
+     * without an associated stopwatch or if the stopwatch has no recorded entries.
+     *
+     * @example
+     * ```typescript
+     * const sw = new Stopwatch(true);
+     * // ... 1200 ms of work ...
+     * const stopEntry = sw.Stop()!;
+     * console.log(stopEntry.ElapsedTotal.Format('LONG')); // "1 second 200 milliseconds"
+     * ```
+     */
+    get ElapsedTotal() {
+        if (!this._stopwatch) {
+            return new ElapsedTime(0);
+        }
+        const firstEntry = this._stopwatch.First;
+        if (!firstEntry) {
+            return new ElapsedTime(0);
+        }
+        return new ElapsedTime(this._timestamp - firstEntry.timestamp);
+    }
+}
+//# sourceMappingURL=entry.js.map

package/build/time/stopwatch/entry.js.map

@@ -0,0 +1 @@
+{"version":3,"file":"entry.js","sourceRoot":"","sources":["../../../src/time/stopwatch/entry.ts"],"names":[],"mappings":"AAAA,OAAO,EAAE,WAAW,EAAE,MAAM,iCAAiC,CAAC;AAG9D;;;;;;;;;;;;;;;;;GAiBG;AACH,MAAM,OAAO,cAAc;IAeG;IAdZ,UAAU,GAAqB,IAAI,CAAC;IAEpC,MAAM,GAAW,CAAC,CAAC,CAAC;IAErC;;;;;;;;;OASG;IACH,YAA6B,UAAkB,EAAE,SAAqB,EAAE,KAAc;QAAzD,eAAU,GAAV,UAAU,CAAQ;QAC9C,IAAI,SAAS,EAAE,CAAC;YACf,IAAI,CAAC,UAAU,GAAG,SAAS,CAAC;YAC5B,IAAI,CAAC,MAAM,GAAG,KAAK,IAAI,CAAC,CAAC;QAC1B,CAAC;IACF,CAAC;IAED;;;;;;;;;OASG;IACH,IAAW,SAAS;QACnB,OAAO,IAAI,CAAC,UAAU,CAAC;IACxB,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,OAAO;QACjB,IAAI,CAAC,IAAI,CAAC,UAAU,IAAI,IAAI,CAAC,MAAM,IAAI,CAAC,EAAE,CAAC;YAC1C,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,aAAa,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC,IAAI,CAAC,MAAM,GAAG,CAAC,CAAC,CAAC;QAC7D,IAAI,CAAC,aAAa,EAAE,CAAC;YACpB,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,GAAG,aAAa,CAAC,SAAS,CAAC,CAAC;IACnE,CAAC;IAED;;;;;;;;;;;;;;OAcG;IACH,IAAW,YAAY;QACtB,IAAI,CAAC,IAAI,CAAC,UAAU,EAAE,CAAC;YACtB,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QACD,MAAM,UAAU,GAAG,IAAI,CAAC,UAAU,CAAC,KAAK,CAAC;QACzC,IAAI,CAAC,UAAU,EAAE,CAAC;YACjB,OAAO,IAAI,WAAW,CAAC,CAAC,CAAC,CAAC;QAC3B,CAAC;QAED,OAAO,IAAI,WAAW,CAAC,IAAI,CAAC,UAAU,GAAG,UAAU,CAAC,SAAS,CAAC,CAAC;IAChE,CAAC;CACD"}