@replayio/protocol - npm Package Compare versions

Comparing version 0.33.0 to 0.34.0

js/client/build/client.d.ts

@@ -275,7 +275,19 @@ import { mayDisconnect, willDisconnect } from "../../protocol/Connection";
         /**
-         * Get a point near a given time in the recording.
+         * Get a point near a given time in the recording. Unlike other commands, this
+         * command will not raise an error if it is performed for an unloaded time.
+         * However, unloaded times will be less densely populated by corresponding
+         * points, so the same command might return different results depending on if
+         * it is being asked about a loaded or unloaded time. In the case that the
+         * answer is generated from coarser data, the <code>precise</code> flag will be
+         * set to <code>false</code>
          */
         getPointNearTime: (parameters: getPointNearTimeParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").getPointNearTimeResult>;
         /**
-         * Get exact points bounding a time as closely as possible
+         * Get exact points bounding a time. Much like <code>getPointNearTime</code>,
+         * this command will not raise an error if it is performed for an unloaded
+         * time. However, unloaded times will be less densely populated by
+         * corresponding points, so the same command might return different results
+         * depending on if it is being asked about a loaded or unloaded time. In the
+         * case that the answer is generated from coarser data, the
+         * <code>precise</code> flag will be set to <code>false</code>
          */
@@ -282,0 +294,0 @@ getPointsBoundingTime: (parameters: getPointsBoundingTimeParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").getPointsBoundingTimeResult>;

js/protocol/index.d.ts

@@ -483,3 +483,9 @@ export * from "./Connection";
     /**
-     * Get a point near a given time in the recording.
+     * Get a point near a given time in the recording. Unlike other commands, this
+     * command will not raise an error if it is performed for an unloaded time.
+     * However, unloaded times will be less densely populated by corresponding
+     * points, so the same command might return different results depending on if
+     * it is being asked about a loaded or unloaded time. In the case that the
+     * answer is generated from coarser data, the <code>precise</code> flag will be
+     * set to <code>false</code>
      */
@@ -494,3 +500,9 @@ "Session.getPointNearTime": {
     /**
-     * Get exact points bounding a time as closely as possible
+     * Get exact points bounding a time. Much like <code>getPointNearTime</code>,
+     * this command will not raise an error if it is performed for an unloaded
+     * time. However, unloaded times will be less densely populated by
+     * corresponding points, so the same command might return different results
+     * depending on if it is being asked about a loaded or unloaded time. In the
+     * case that the answer is generated from coarser data, the
+     * <code>precise</code> flag will be set to <code>false</code>
      */
@@ -497,0 +509,0 @@ "Session.getPointsBoundingTime": {

js/protocol/Session.d.ts

@@ -57,2 +57,3 @@ import { CloseTimestamp } from "./Connection";
 export interface getPointNearTimeResult {
+    precise: boolean;
     point: TimeStampedPoint;
@@ -64,2 +65,3 @@ }
 export interface getPointsBoundingTimeResult {
+    precise: boolean;
     after: TimeStampedPoint;
@@ -66,0 +68,0 @@ before: TimeStampedPoint;

package.json

 {
   "name": "@replayio/protocol",
-  "version": "0.33.0",
+  "version": "0.34.0",
   "description": "Definition of the protocol used by the Record Replay web service",
@@ -5,0 +5,0 @@ "author": "",

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

518694

increased by0.8%

Lines of code

12033

increased by0.4%

No dependency changes