superfly-timeline - npm Package Compare versions

Comparing version 9.0.0-nightly-wip-big-rewrite-20230707-094049-a13df02.0 to 9.0.0-nightly-wip-big-rewrite-20230707-163829-1216273.0

dist/api/resolvedTimeline.d.ts

@@ -8,3 +8,3 @@ import { Content, TimelineObject } from './timeline';
  *
- * To retrieve a state at a certain time, use getResolvedState(resolvedTimeline).
+ * To retrieve a state at a certain time, use getResolvedState(resolvedTimeline, time).
  *
@@ -58,3 +58,3 @@ * Note: If `limitTime` was specified in the ResolveOptions,
         isKeyframe: boolean;
-        /** Is set to true while object is resolved (to prevent circular references) */
+        /** Is set to true while object is being resolved (to prevent circular references) */
         resolving: boolean;
@@ -61,0 +61,0 @@ /** Is set to true when object is resolved first time, and isn't reset thereafter */

dist/api/resolver.d.ts

@@ -17,3 +17,3 @@ import { ResolvedTimelineObjects } from './resolvedTimeline';
      * Limits the repeating objects and nextEvents to a time in the future.
-     * It is recommended set this to a time in the future at which point you plan to re-resolve the timeline again.
+     * It is recommended to set this to a time in the future at which you plan to re-resolve the timeline again.
      */
@@ -24,3 +24,3 @@ limitTime?: Time;
      * If you provide this, ensure that you provide the same object between resolves.
-     * When set, will increase performance, especially when there are only small changes to the timeline.
+     * Setting it will increase performance, especially when there are only small changes to the timeline.
      */
@@ -27,0 +27,0 @@ cache?: Partial<ResolverCache>;

dist/api/state.d.ts

@@ -5,5 +5,4 @@ import { NextEvent, ResolvedTimelineObjectInstance } from './resolvedTimeline';
 /**
- * A TimelineState is a moment in time,
- * containing a cross-section of the timeline,
- * ie all objects that are active at that point in time.
+ * TimelineState is a cross-section of the timeline at a given point in time,
+ * i.e. all objects that are active at that moment.
  */
@@ -10,0 +9,0 @@ export interface TimelineState<TContent extends Content = Content> {

dist/index.d.ts

@@ -7,3 +7,3 @@ import { ResolvedTimeline, ResolveOptions, Expression, ExpressionObj, InnerExpression, Time, TimelineState, Content, TimelineKeyframe, TimelineObject } from './api';
  */
-export declare function resolveTimeline(timeline: TimelineObject[], options: ResolveOptions): ResolvedTimeline;
+export declare function resolveTimeline<TContent extends Content = Content>(timeline: TimelineObject<TContent>[], options: ResolveOptions): ResolvedTimeline<TContent>;
 /**
@@ -16,3 +16,3 @@ * Retrieve the state for a certain point in time.
  */
-export declare function getResolvedState(resolvedTimeline: ResolvedTimeline, time: Time, eventLimit?: number): TimelineState;
+export declare function getResolvedState<TContent extends Content = Content>(resolvedTimeline: ResolvedTimeline<TContent>, time: Time, eventLimit?: number): TimelineState<TContent>;
 /**
@@ -43,3 +43,3 @@ * Validates all objects in the timeline. Throws an error if something's wrong
 /**
- * Apply keyframe content onto it's parent content.
+ * Apply keyframe content onto its parent content.
  * The keyframe content is deeply-applied onto the parent content.
@@ -46,0 +46,0 @@ * Note: This function mutates the parentContent.

dist/index.js

@@ -71,3 +71,3 @@ "use strict";
 /**
- * Apply keyframe content onto it's parent content.
+ * Apply keyframe content onto its parent content.
  * The keyframe content is deeply-applied onto the parent content.
@@ -74,0 +74,0 @@ * Note: This function mutates the parentContent.

dist/resolver/ResolvedTimelineHandler.d.ts

 import { ResolvedTimeline, ResolvedTimelineObject, TimelineObjectInstance } from '../api/resolvedTimeline';
-import { TimelineKeyframe, TimelineObject } from '../api/timeline';
+import { Content, TimelineKeyframe, TimelineObject } from '../api/timeline';
 import { InstanceId, ResolveOptions, ResolverCache } from '../api';
@@ -12,6 +12,6 @@ import { CacheHandler } from './CacheHandler';
  */
-export declare class ResolvedTimelineHandler {
+export declare class ResolvedTimelineHandler<TContent extends Content = Content> {
     options: ResolveOptions;
     /** Maps object id to object */
-    objectsMap: Map<string, ResolvedTimelineObject<import("../api").Content>>;
+    objectsMap: Map<string, ResolvedTimelineObject<TContent>>;
     /** Maps className to a list of object ids  */
@@ -51,3 +51,3 @@ classesMap: Map<string, string[]>;
     /** Populate ResolvedTimelineHandler with a timeline-object. */
-    addTimelineObject(obj: TimelineObject): void;
+    addTimelineObject(obj: TimelineObject<TContent>): void;
     /** Resolve the timeline. */
@@ -103,4 +103,4 @@ resolveAllTimelineObjs(): void;
 }
-export interface TimelineObjectKeyframe extends TimelineObject, TimelineKeyframe {
+export interface TimelineObjectKeyframe<TContent extends Content = Content> extends TimelineObject<TContent>, TimelineKeyframe<TContent> {
 }
 //# sourceMappingURL=ResolvedTimelineHandler.d.ts.map

dist/resolver/ResolverHandler.d.ts

 import { ResolvedTimeline } from '../api/resolvedTimeline';
 import { ResolveOptions } from '../api/resolver';
-import { TimelineObject } from '../api/timeline';
+import { Content, TimelineObject } from '../api/timeline';
 /**
@@ -10,3 +10,3 @@ * Note: A Resolver instance is short-lived and used to resolve a timeline.
  */
-export declare class ResolverHandler {
+export declare class ResolverHandler<TContent extends Content = Content> {
     private options;
@@ -22,3 +22,3 @@ private hasRun;
      */
-    resolveTimeline(timeline: TimelineObject[]): ResolvedTimeline;
+    resolveTimeline(timeline: TimelineObject<TContent>[]): ResolvedTimeline<TContent>;
     /** Update this.nextEvents */
@@ -25,0 +25,0 @@ private updateNextEvents;

dist/resolver/StateHandler.d.ts

 import { Content, ResolvedTimeline, Time, TimelineState } from '../api';
 export declare class StateHandler {
-    getState(resolvedTimeline: ResolvedTimeline, time: Time, eventLimit?: number): TimelineState;
+    getState<TContent extends Content = Content>(resolvedTimeline: ResolvedTimeline<TContent>, time: Time, eventLimit?: number): TimelineState<TContent>;
     /**
@@ -5,0 +5,0 @@ * Apply keyframe content onto it's parent content.

package.json

 {
 	"name": "superfly-timeline",
-	"version": "9.0.0-nightly-wip-big-rewrite-20230707-094049-a13df02.0",
+	"version": "9.0.0-nightly-wip-big-rewrite-20230707-163829-1216273.0",
 	"description": "A collection of rules as well as a resolver for placing objects on a virtual timeline.",
@@ -5,0 +5,0 @@ "license": "MIT",

README.md

@@ -166,3 +166,3 @@ # SuperFly-Timeline
 
-Note: If neither of `.end`, `.duration` or `.while` are set, the object will continue indefinitely.
+Note: If neither `.end`, `.duration`, or `.while` is set, the object will continue indefinitely.
 
@@ -197,3 +197,3 @@ **Examples**
 - Only **one** object can exist on a layer at the same time.
-- If two (or more) objects conflicts, ie fight for the place on a layer:
+- If two (or more) objects conflict, ie fight for the place on a layer:
   - The one with highest `.priority` will win.
@@ -200,0 +200,0 @@ - If tied, the one with _latest start time_ will win.

New alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Fixed alerts

License Policy Violation

License

This package is not allowed per your license policy. Review the package's license to ensure compliance.

Found 1 instance in 1 package

Improved metrics

Total package byte prevSize

410105

increased by0.21%

Worsened metrics

Lines of code

4303

decreased by-0.02%

No dependency changes