@awesome-ecs/abstract 0.20.0 → 0.20.2

package/dist/factories/index.d.cts

@@ -1,26 +1,56 @@
-import { c as IEntity } from '../index-DK2CXVZ8.cjs';
-import { I as ISystemsRuntimeContext, a as ISystemContext } from '../systems-runtime-context-C-PeYs1I.cjs';
-import { I as IPipelineContext, M as MiddlewareResult, a as IPipeline } from '../pipeline-BowCAITe.cjs';
-import '../types-BNwBqRWY.cjs';
-import '../entity-repository-DmfcUSrX.cjs';
+import { c as IEntity } from '../index-CnlpX7ys.cjs';
+import { I as ISystemsRuntimeContext, a as ISystemContext } from '../systems-runtime-context-DhtHMczN.cjs';
+import { I as IPipelineContext, M as MiddlewareResult, a as IPipeline } from '../pipeline-DunwPUPZ.cjs';
+import '../types-cZ-1lGPD.cjs';
+import '../entity-repository-DJ1xbvaN.cjs';
 import '../utils/index.cjs';
-import '../performance-timer-XvdCbcAE.cjs';
+import '../performance-timer-BVyl0SRs.cjs';
 
 /**
- * The IContextFactory can be used as an abstraction layer to quickly create Pipeline Contexts,
- * without having to manually resolve all of their dependencies.
+ * The IContextFactory interface is used to create abstraction layers for quickly creating Pipeline Contexts.
+ * It helps to avoid manually resolving all dependencies when creating these contexts.
  */
 interface IContextFactory {
+    /**
+     * Creates a new instance of ISystemsRuntimeContext.
+     *
+     * @template TEntity - The type of entity to be used in the runtime context. It must extend IEntity.
+     * @returns A new instance of ISystemsRuntimeContext with the specified entity type.
+     */
     createRuntimeContext<TEntity extends IEntity>(): ISystemsRuntimeContext<TEntity>;
 }
 
 /**
- * The PipelineFactory can be used as an abstraction layer to quickly create IPipeline objects,
- * without having to manually resolve all of their dependencies.
+ * The PipelineFactory interface provides methods to create different types of pipelines.
+ * It helps to quickly create IPipeline objects without manually resolving their dependencies.
  */
 interface IPipelineFactory {
+    /**
+     * Creates a new pipeline with the specified context and result type.
+     *
+     * @template TContext - The type of the pipeline context. It must extend IPipelineContext.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified context and result type.
+     */
     createPipeline<TContext extends IPipelineContext, TResult = MiddlewareResult>(name?: string): IPipeline<TContext, TResult>;
+    /**
+     * Creates a new pipeline specifically for systems with the specified entity type and result type.
+     *
+     * @template TEntity - The type of the entity. It must extend IEntity.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified system context and result type.
+     */
     createSystemsPipeline<TEntity extends IEntity, TResult = MiddlewareResult>(name?: string): IPipeline<ISystemContext<TEntity>, TResult>;
+    /**
+     * Creates a new pipeline specifically for systems runtime with the specified entity type and result type.
+     *
+     * @template TEntity - The type of the entity. It must extend IEntity.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified systems runtime context and result type.
+     */
     createRuntimePipeline<TEntity extends IEntity, TResult = MiddlewareResult>(name?: string): IPipeline<ISystemsRuntimeContext<TEntity>, TResult>;
 }
 

package/dist/factories/index.d.ts

@@ -1,26 +1,56 @@
-import { c as IEntity } from '../index-BPDsRt_F.js';
-import { I as ISystemsRuntimeContext, a as ISystemContext } from '../systems-runtime-context-B2ch9kB3.js';
-import { I as IPipelineContext, M as MiddlewareResult, a as IPipeline } from '../pipeline-D43CXxWG.js';
-import '../types-BNwBqRWY.js';
-import '../entity-repository-BASmOrq7.js';
+import { c as IEntity } from '../index-B1KXekZD.js';
+import { I as ISystemsRuntimeContext, a as ISystemContext } from '../systems-runtime-context-BTNdV8Z-.js';
+import { I as IPipelineContext, M as MiddlewareResult, a as IPipeline } from '../pipeline-BGsQiSer.js';
+import '../types-cZ-1lGPD.js';
+import '../entity-repository-BlSpo-x2.js';
 import '../utils/index.js';
-import '../performance-timer-XvdCbcAE.js';
+import '../performance-timer-BVyl0SRs.js';
 
 /**
- * The IContextFactory can be used as an abstraction layer to quickly create Pipeline Contexts,
- * without having to manually resolve all of their dependencies.
+ * The IContextFactory interface is used to create abstraction layers for quickly creating Pipeline Contexts.
+ * It helps to avoid manually resolving all dependencies when creating these contexts.
  */
 interface IContextFactory {
+    /**
+     * Creates a new instance of ISystemsRuntimeContext.
+     *
+     * @template TEntity - The type of entity to be used in the runtime context. It must extend IEntity.
+     * @returns A new instance of ISystemsRuntimeContext with the specified entity type.
+     */
     createRuntimeContext<TEntity extends IEntity>(): ISystemsRuntimeContext<TEntity>;
 }
 
 /**
- * The PipelineFactory can be used as an abstraction layer to quickly create IPipeline objects,
- * without having to manually resolve all of their dependencies.
+ * The PipelineFactory interface provides methods to create different types of pipelines.
+ * It helps to quickly create IPipeline objects without manually resolving their dependencies.
  */
 interface IPipelineFactory {
+    /**
+     * Creates a new pipeline with the specified context and result type.
+     *
+     * @template TContext - The type of the pipeline context. It must extend IPipelineContext.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified context and result type.
+     */
     createPipeline<TContext extends IPipelineContext, TResult = MiddlewareResult>(name?: string): IPipeline<TContext, TResult>;
+    /**
+     * Creates a new pipeline specifically for systems with the specified entity type and result type.
+     *
+     * @template TEntity - The type of the entity. It must extend IEntity.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified system context and result type.
+     */
     createSystemsPipeline<TEntity extends IEntity, TResult = MiddlewareResult>(name?: string): IPipeline<ISystemContext<TEntity>, TResult>;
+    /**
+     * Creates a new pipeline specifically for systems runtime with the specified entity type and result type.
+     *
+     * @template TEntity - The type of the entity. It must extend IEntity.
+     * @template TResult - The type of the result returned by the pipeline. Default is MiddlewareResult.
+     * @param name - Optional name for the pipeline. If not provided, a default name will be assigned.
+     * @returns A new instance of IPipeline with the specified systems runtime context and result type.
+     */
     createRuntimePipeline<TEntity extends IEntity, TResult = MiddlewareResult>(name?: string): IPipeline<ISystemsRuntimeContext<TEntity>, TResult>;
 }
 

package/dist/index-B1KXekZD.d.ts

@@ -0,0 +1,199 @@
+import { B as BooleanProps, I as Immutable } from './types-cZ-1lGPD.js';
+
+type ComponentTypeUid = string | number;
+/**
+ * The `IComponent` interface provides the main storage mechanism of `IEntity` state, and can be accessed and modified by `Systems`.
+ *
+ * The `IComponent` implementations should not contain any logic methods, apart from quick-access functionality.
+ */
+interface IComponent {
+    /**
+     * The `ComponentTypeUid` is a unique identifier for each Component type.
+     * @type {ComponentTypeUid}
+     */
+    readonly componentType: ComponentTypeUid;
+    /**
+     * Specifies whether the Component state should be serialized as part of an `IEntitySnapshot`.
+     * This is useful if the state needs to be replicated or updated through remote updates (e.g., coming from the server or peers).
+     * @type {boolean}
+     */
+    readonly isSerializable: boolean;
+    /**
+     * @optional
+     * Specifies the current version of the component.
+     * This is useful for keeping backwards-compatibility when the stored state might be of a different version.
+     * @type {number}
+     */
+    readonly version?: number;
+    /**
+     * @optional
+     * The custom serialization function of this Component, used to transfer it into a Snapshot, or used for logging the Component stored state.
+     * If not provided, the standard `JSON.stringify()` functionality applies.
+     * @returns {string | object} The serialized form of the Component.
+     */
+    toJSON?(): string | object;
+    /**
+     * Allows for custom logic when loading the current from an `IEntitySnapshot`.
+     * The default behavior simply overwrites the fields with the target state.
+     * @param {this} targetState The target state to load from.
+     */
+    load?(targetState: this): void;
+}
+
+/**
+ * The `IEntityProxy` represents a pointer to another `Entity`.
+ */
+interface IEntityProxy {
+    /**
+     * The type of the entity that the proxy points to.
+     */
+    readonly entityType: EntityTypeUid;
+    /**
+     * The unique identifier of the entity that the proxy points to.
+     */
+    readonly entityUid: EntityUid;
+}
+/**
+ * A utility extension of `IEntityProxy`.
+ * Useful for providing strong `Type` information when using the IEntityProxy.
+ *
+ * @template TEntity - The type of the entity that the proxy points to.
+ */
+interface EntityProxy<TEntity extends IEntity> extends IEntityProxy {
+}
+/**
+ * The `IEntityProxiesManager` is a helper to encapsulate logic for registering & removing Entity proxies.
+ *
+ * It handles the complexities of bi-directional registrations and offers an abstraction for the Proxy handling.
+ */
+interface IEntityProxiesManager {
+    /**
+     * Registers a single proxy for an entity.
+     *
+     * @param entity - The entity to register the proxy for.
+     * @param proxy - The proxy to register.
+     * @param cleanup - If true, any existing proxies of the same type will be removed before registering the new one.
+     */
+    registerProxy(entity: IEntity, proxy: IEntityProxy, cleanup?: boolean): void;
+    /**
+     * Registers multiple proxies for an entity.
+     *
+     * @param entity - The entity to register the proxies for.
+     * @param proxies - The proxies to register.
+     * @param cleanup - If true, any existing proxies of the same type will be removed before registering the new ones.
+     */
+    registerProxies(entity: IEntity, proxies: IEntityProxy[], cleanup?: boolean): void;
+    /**
+     * Removes a single proxy from an entity.
+     *
+     * @param entity - The entity to remove the proxy from.
+     * @param proxy - The proxy to remove.
+     */
+    removeProxy(entity: IEntity, proxy: IEntityProxy): void;
+    /**
+     * Removes all proxies from an entity, optionally filtering by proxy entity type.
+     *
+     * @param entity - The entity to remove the proxies from.
+     * @param proxyEntityType - The type of the proxy entity to filter by.
+     */
+    removeProxies(entity: IEntity, proxyEntityType?: EntityTypeUid): void;
+}
+
+/**
+ * Represents the unique identifier for an entity type.
+ * Can be either a string or a number.
+ */
+type EntityTypeUid = string | number;
+/**
+ * Represents the unique identifier for an entity.
+ * Can be either a string or a number.
+ */
+type EntityUid = string | number;
+/**
+ * The `IEntityModel` represents the basic identity information about the current `IEntity`.
+ * It's mandatory for each Entity, and it contains the minimal-required information needed for instantiating the Entity.
+ *
+ * The Features property can be used to toggle Entity features on and off.
+ *
+ * @template TFeatures - A type that extends `BooleanProps<TFeatures>` to represent the features of the entity.
+ *                      Defaults to `unknown` if not provided.
+ */
+interface IEntityModel<TFeatures extends BooleanProps<TFeatures> = unknown> {
+    /**
+     * The unique identifier of the entity.
+     */
+    readonly uid: EntityUid;
+    /**
+     * Optional features of the entity.
+     * The type of this property should extend `BooleanProps<TFeatures>`.
+     */
+    readonly features?: TFeatures;
+}
+/**
+ * The `IEntity` interface represents a container of Components and Entity Proxies.
+ * It is designed to be immutable and only modifiable through System operations.
+ *
+ * Implementations of `IEntity` can contain quick-access methods for `Components` or `Proxies`,
+ * but should not contain any state-changing logic apart from quick-access functionality.
+ */
+interface IEntity {
+    /**
+     * A Map of Components associated with this Entity.
+     * The keys are ComponentTypeUid, and the values are IComponent instances.
+     */
+    readonly components: Map<ComponentTypeUid, IComponent>;
+    /**
+     * A Map of Entity Proxies associated with this Entity.
+     * The outer Map's keys are EntityTypeUid, and the inner Map's keys are EntityUid.
+     * The values are IEntityProxy instances.
+     */
+    readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
+    /**
+     * The IdentityComponent represents mandatory state any Entity needs to have.
+     * It is a readonly reference to an IdentityComponent instance, which contains the minimal-required information
+     * needed for instantiating the Entity.
+     */
+    readonly identity: Readonly<IdentityComponent<IEntityModel>>;
+    /**
+     * A reference to the own Proxy of this Entity.
+     * It is a readonly reference to an IEntityProxy instance, which points to this Entity.
+     * This is useful for quick access of Proxy data.
+     */
+    readonly myProxy: Readonly<IEntityProxy>;
+}
+
+/**
+ * The `BasicComponentType` enum defines the types of basic components available.
+ */
+declare enum BasicComponentType {
+    identity = "identity"
+}
+/**
+ * IdentityComponent interface represents the basic information regarding what makes the current Entity unique.
+ * It extends the IComponent interface.
+ *
+ * @template TModel - The type of the model that extends IEntityModel.
+ */
+interface IdentityComponent<TModel extends IEntityModel> extends IComponent {
+    /**
+     * The Entity Type that defines what Category type the Entity is part of.
+     * There can be multiple Entities sharing the same EntityType.
+     */
+    readonly entityType: EntityTypeUid;
+    /**
+     * The Model is the basic information needed to create an `IEntity` when it's first initialized.
+     * It provides a first snapshot of information needed for the successful creation of an Entity instance.
+     *
+     * @type {Immutable<TModel>}
+     */
+    readonly model: Immutable<TModel>;
+    /**
+     * Keeps track when the Entity's systems have ran last.
+     * Useful to calculate the `DeltaTime` between runs.
+     *
+     * @type {Date | undefined}
+     */
+    readonly lastUpdated?: Date;
+}
+
+export { BasicComponentType as B, type ComponentTypeUid as C, type EntityTypeUid as E, type IEntityProxy as I, type EntityUid as a, type IEntityModel as b, type IEntity as c, type EntityProxy as d, type IEntityProxiesManager as e, type IdentityComponent as f, type IComponent as g };

package/dist/index-CnlpX7ys.d.cts

@@ -0,0 +1,199 @@
+import { B as BooleanProps, I as Immutable } from './types-cZ-1lGPD.cjs';
+
+type ComponentTypeUid = string | number;
+/**
+ * The `IComponent` interface provides the main storage mechanism of `IEntity` state, and can be accessed and modified by `Systems`.
+ *
+ * The `IComponent` implementations should not contain any logic methods, apart from quick-access functionality.
+ */
+interface IComponent {
+    /**
+     * The `ComponentTypeUid` is a unique identifier for each Component type.
+     * @type {ComponentTypeUid}
+     */
+    readonly componentType: ComponentTypeUid;
+    /**
+     * Specifies whether the Component state should be serialized as part of an `IEntitySnapshot`.
+     * This is useful if the state needs to be replicated or updated through remote updates (e.g., coming from the server or peers).
+     * @type {boolean}
+     */
+    readonly isSerializable: boolean;
+    /**
+     * @optional
+     * Specifies the current version of the component.
+     * This is useful for keeping backwards-compatibility when the stored state might be of a different version.
+     * @type {number}
+     */
+    readonly version?: number;
+    /**
+     * @optional
+     * The custom serialization function of this Component, used to transfer it into a Snapshot, or used for logging the Component stored state.
+     * If not provided, the standard `JSON.stringify()` functionality applies.
+     * @returns {string | object} The serialized form of the Component.
+     */
+    toJSON?(): string | object;
+    /**
+     * Allows for custom logic when loading the current from an `IEntitySnapshot`.
+     * The default behavior simply overwrites the fields with the target state.
+     * @param {this} targetState The target state to load from.
+     */
+    load?(targetState: this): void;
+}
+
+/**
+ * The `IEntityProxy` represents a pointer to another `Entity`.
+ */
+interface IEntityProxy {
+    /**
+     * The type of the entity that the proxy points to.
+     */
+    readonly entityType: EntityTypeUid;
+    /**
+     * The unique identifier of the entity that the proxy points to.
+     */
+    readonly entityUid: EntityUid;
+}
+/**
+ * A utility extension of `IEntityProxy`.
+ * Useful for providing strong `Type` information when using the IEntityProxy.
+ *
+ * @template TEntity - The type of the entity that the proxy points to.
+ */
+interface EntityProxy<TEntity extends IEntity> extends IEntityProxy {
+}
+/**
+ * The `IEntityProxiesManager` is a helper to encapsulate logic for registering & removing Entity proxies.
+ *
+ * It handles the complexities of bi-directional registrations and offers an abstraction for the Proxy handling.
+ */
+interface IEntityProxiesManager {
+    /**
+     * Registers a single proxy for an entity.
+     *
+     * @param entity - The entity to register the proxy for.
+     * @param proxy - The proxy to register.
+     * @param cleanup - If true, any existing proxies of the same type will be removed before registering the new one.
+     */
+    registerProxy(entity: IEntity, proxy: IEntityProxy, cleanup?: boolean): void;
+    /**
+     * Registers multiple proxies for an entity.
+     *
+     * @param entity - The entity to register the proxies for.
+     * @param proxies - The proxies to register.
+     * @param cleanup - If true, any existing proxies of the same type will be removed before registering the new ones.
+     */
+    registerProxies(entity: IEntity, proxies: IEntityProxy[], cleanup?: boolean): void;
+    /**
+     * Removes a single proxy from an entity.
+     *
+     * @param entity - The entity to remove the proxy from.
+     * @param proxy - The proxy to remove.
+     */
+    removeProxy(entity: IEntity, proxy: IEntityProxy): void;
+    /**
+     * Removes all proxies from an entity, optionally filtering by proxy entity type.
+     *
+     * @param entity - The entity to remove the proxies from.
+     * @param proxyEntityType - The type of the proxy entity to filter by.
+     */
+    removeProxies(entity: IEntity, proxyEntityType?: EntityTypeUid): void;
+}
+
+/**
+ * Represents the unique identifier for an entity type.
+ * Can be either a string or a number.
+ */
+type EntityTypeUid = string | number;
+/**
+ * Represents the unique identifier for an entity.
+ * Can be either a string or a number.
+ */
+type EntityUid = string | number;
+/**
+ * The `IEntityModel` represents the basic identity information about the current `IEntity`.
+ * It's mandatory for each Entity, and it contains the minimal-required information needed for instantiating the Entity.
+ *
+ * The Features property can be used to toggle Entity features on and off.
+ *
+ * @template TFeatures - A type that extends `BooleanProps<TFeatures>` to represent the features of the entity.
+ *                      Defaults to `unknown` if not provided.
+ */
+interface IEntityModel<TFeatures extends BooleanProps<TFeatures> = unknown> {
+    /**
+     * The unique identifier of the entity.
+     */
+    readonly uid: EntityUid;
+    /**
+     * Optional features of the entity.
+     * The type of this property should extend `BooleanProps<TFeatures>`.
+     */
+    readonly features?: TFeatures;
+}
+/**
+ * The `IEntity` interface represents a container of Components and Entity Proxies.
+ * It is designed to be immutable and only modifiable through System operations.
+ *
+ * Implementations of `IEntity` can contain quick-access methods for `Components` or `Proxies`,
+ * but should not contain any state-changing logic apart from quick-access functionality.
+ */
+interface IEntity {
+    /**
+     * A Map of Components associated with this Entity.
+     * The keys are ComponentTypeUid, and the values are IComponent instances.
+     */
+    readonly components: Map<ComponentTypeUid, IComponent>;
+    /**
+     * A Map of Entity Proxies associated with this Entity.
+     * The outer Map's keys are EntityTypeUid, and the inner Map's keys are EntityUid.
+     * The values are IEntityProxy instances.
+     */
+    readonly proxies: Map<EntityTypeUid, Map<EntityUid, IEntityProxy>>;
+    /**
+     * The IdentityComponent represents mandatory state any Entity needs to have.
+     * It is a readonly reference to an IdentityComponent instance, which contains the minimal-required information
+     * needed for instantiating the Entity.
+     */
+    readonly identity: Readonly<IdentityComponent<IEntityModel>>;
+    /**
+     * A reference to the own Proxy of this Entity.
+     * It is a readonly reference to an IEntityProxy instance, which points to this Entity.
+     * This is useful for quick access of Proxy data.
+     */
+    readonly myProxy: Readonly<IEntityProxy>;
+}
+
+/**
+ * The `BasicComponentType` enum defines the types of basic components available.
+ */
+declare enum BasicComponentType {
+    identity = "identity"
+}
+/**
+ * IdentityComponent interface represents the basic information regarding what makes the current Entity unique.
+ * It extends the IComponent interface.
+ *
+ * @template TModel - The type of the model that extends IEntityModel.
+ */
+interface IdentityComponent<TModel extends IEntityModel> extends IComponent {
+    /**
+     * The Entity Type that defines what Category type the Entity is part of.
+     * There can be multiple Entities sharing the same EntityType.
+     */
+    readonly entityType: EntityTypeUid;
+    /**
+     * The Model is the basic information needed to create an `IEntity` when it's first initialized.
+     * It provides a first snapshot of information needed for the successful creation of an Entity instance.
+     *
+     * @type {Immutable<TModel>}
+     */
+    readonly model: Immutable<TModel>;
+    /**
+     * Keeps track when the Entity's systems have ran last.
+     * Useful to calculate the `DeltaTime` between runs.
+     *
+     * @type {Date | undefined}
+     */
+    readonly lastUpdated?: Date;
+}
+
+export { BasicComponentType as B, type ComponentTypeUid as C, type EntityTypeUid as E, type IEntityProxy as I, type EntityUid as a, type IEntityModel as b, type IEntity as c, type EntityProxy as d, type IEntityProxiesManager as e, type IdentityComponent as f, type IComponent as g };

package/dist/performance-timer-BVyl0SRs.d.cts

@@ -0,0 +1,45 @@
+/**
+ * A unique identifier for a timer.
+ */
+type PerformanceTimerUid = number;
+/**
+ * A record of a timer's execution.
+ *
+ * @remarks
+ * This interface represents the details of a timer's execution.
+ * It includes the timer's name, start timestamp, end timestamp, and the duration of the timer's execution in milliseconds.
+ *
+ * @property {string} name - The name of the timer.
+ * @property {number} startedAt - The timestamp when the timer started.
+ * @property {number} [endedAt] - The timestamp when the timer ended.
+ * @property {number} [msPassed] - The time in milliseconds that the timer was active.
+ */
+interface PerformanceTimeEntry {
+    name: string;
+    startedAt: number;
+    endedAt?: number;
+    msPassed?: number;
+}
+/**
+ * An interface for a performance timer.
+ * This interface provides methods to start and end timers,
+ * and retrieve information about their execution.
+ */
+interface IPerformanceTimer {
+    /**
+     * Starts a new timer with the given name.
+     * @param {string} name - The name of the timer.
+     * @returns {PerformanceTimerUid} - A unique identifier for the newly started timer.
+     */
+    startTimer(name: string): PerformanceTimerUid;
+    /**
+     * Ends the timer with the given timerUid and returns a record of its execution.
+     * @param {PerformanceTimerUid} timerUid - The unique identifier of the timer to end.
+     * @returns {PerformanceTimeEntry} - A record of the timer's execution.
+     * The returned object contains the timer's name, start timestamp, end timestamp,
+     * and the duration of the timer's execution in milliseconds.
+     */
+    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
+}
+
+export type { IPerformanceTimer as I, PerformanceTimeEntry as P, PerformanceTimerUid as a };

package/dist/performance-timer-BVyl0SRs.d.ts

@@ -0,0 +1,45 @@
+/**
+ * A unique identifier for a timer.
+ */
+type PerformanceTimerUid = number;
+/**
+ * A record of a timer's execution.
+ *
+ * @remarks
+ * This interface represents the details of a timer's execution.
+ * It includes the timer's name, start timestamp, end timestamp, and the duration of the timer's execution in milliseconds.
+ *
+ * @property {string} name - The name of the timer.
+ * @property {number} startedAt - The timestamp when the timer started.
+ * @property {number} [endedAt] - The timestamp when the timer ended.
+ * @property {number} [msPassed] - The time in milliseconds that the timer was active.
+ */
+interface PerformanceTimeEntry {
+    name: string;
+    startedAt: number;
+    endedAt?: number;
+    msPassed?: number;
+}
+/**
+ * An interface for a performance timer.
+ * This interface provides methods to start and end timers,
+ * and retrieve information about their execution.
+ */
+interface IPerformanceTimer {
+    /**
+     * Starts a new timer with the given name.
+     * @param {string} name - The name of the timer.
+     * @returns {PerformanceTimerUid} - A unique identifier for the newly started timer.
+     */
+    startTimer(name: string): PerformanceTimerUid;
+    /**
+     * Ends the timer with the given timerUid and returns a record of its execution.
+     * @param {PerformanceTimerUid} timerUid - The unique identifier of the timer to end.
+     * @returns {PerformanceTimeEntry} - A record of the timer's execution.
+     * The returned object contains the timer's name, start timestamp, end timestamp,
+     * and the duration of the timer's execution in milliseconds.
+     */
+    endTimer(timerUid: PerformanceTimerUid): PerformanceTimeEntry;
+}
+
+export type { IPerformanceTimer as I, PerformanceTimeEntry as P, PerformanceTimerUid as a };