@recordreplay/protocol
Advanced tools
@recordreplay/protocol - npm Package Compare versions
Comparing version 0.8.2 to 0.9.0
@@ -147,2 +147,9 @@ import { uploadedData, awaitingSourcemaps, sessionError, getDescriptionParameters, createSessionParameters, releaseSessionParameters, processRecordingParameters, addSourceMapParameters, addOriginalSourceParameters } from "../../protocol/Recording"; | ||
| * see <code>ProcessingLevel</code> for details. | ||
| * | ||
| * For the <code>executionIndexed</code> level of processing, note that indexing | ||
| * information will not be available for unloaded parts of the recording | ||
| * (see <code>Session.listenForLoadChanges</code>) even after processing | ||
| * completes. If processing completes and a <code>Session.loadRegion</code> | ||
| * command is sent, this command can be sent again to wait until indexing of | ||
| * the newly loaded region completes. | ||
| */ | ||
@@ -182,3 +189,5 @@ ensureProcessed: (parameters: ensureProcessedParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").ensureProcessedResult>; | ||
| * earlier loaded regions may be unloaded to reduce backend resource usage. | ||
| * Pauses cannot be created or used in unloaded parts of the recording. | ||
| * Pauses cannot be created or used in unloaded parts of the recording, | ||
| * and information from the <code>executionIndexed</code> processing Level | ||
| * will not be available. | ||
| */ | ||
@@ -386,2 +395,6 @@ listenForLoadChanges: (parameters: listenForLoadChangesParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Session").listenForLoadChangesResult>; | ||
| * Get the points of all steps that are executed by a frame. | ||
| * | ||
| * If this is a generator frame then steps from all places where the frame | ||
| * executed will be returned, except in parts of the recording are unloaded | ||
| * (see <code>Session.listenForLoadChanges</code>). | ||
| */ | ||
@@ -520,3 +533,4 @@ getFrameSteps: (parameters: getFrameStepsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Pause").getFrameStepsResult>; | ||
| * Does not return until the analysis has finished and all events have been | ||
| * emitted. | ||
| * emitted. Results will not be gathered in parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -534,2 +548,4 @@ runAnalysis: (parameters: runAnalysisParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Analysis").runAnalysisResult>; | ||
| * are found. Does not return until events for all points have been emitted. | ||
| * Points will not be emitted for parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -536,0 +552,0 @@ findAnalysisPoints: (parameters: findAnalysisPointsParameters, sessionId?: string | undefined, pauseId?: string | undefined) => Promise<import("../../protocol/Analysis").findAnalysisPointsResult>; |
@@ -173,2 +173,9 @@ "use strict"; | ||
| * see <code>ProcessingLevel</code> for details. | ||
| * | ||
| * For the <code>executionIndexed</code> level of processing, note that indexing | ||
| * information will not be available for unloaded parts of the recording | ||
| * (see <code>Session.listenForLoadChanges</code>) even after processing | ||
| * completes. If processing completes and a <code>Session.loadRegion</code> | ||
| * command is sent, this command can be sent again to wait until indexing of | ||
| * the newly loaded region completes. | ||
| */ | ||
@@ -220,3 +227,5 @@ ensureProcessed: function (parameters, sessionId, pauseId) { | ||
| * earlier loaded regions may be unloaded to reduce backend resource usage. | ||
| * Pauses cannot be created or used in unloaded parts of the recording. | ||
| * Pauses cannot be created or used in unloaded parts of the recording, | ||
| * and information from the <code>executionIndexed</code> processing Level | ||
| * will not be available. | ||
| */ | ||
@@ -498,2 +507,6 @@ listenForLoadChanges: function (parameters, sessionId, pauseId) { | ||
| * Get the points of all steps that are executed by a frame. | ||
| * | ||
| * If this is a generator frame then steps from all places where the frame | ||
| * executed will be returned, except in parts of the recording are unloaded | ||
| * (see <code>Session.listenForLoadChanges</code>). | ||
| */ | ||
@@ -676,3 +689,4 @@ getFrameSteps: function (parameters, sessionId, pauseId) { | ||
| * Does not return until the analysis has finished and all events have been | ||
| * emitted. | ||
| * emitted. Results will not be gathered in parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -694,2 +708,4 @@ runAnalysis: function (parameters, sessionId, pauseId) { | ||
| * are found. Does not return until events for all points have been emitted. | ||
| * Points will not be emitted for parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -696,0 +712,0 @@ findAnalysisPoints: function (parameters, sessionId, pauseId) { |
@@ -263,2 +263,9 @@ export * from "./Recording"; | ||
| * see <code>ProcessingLevel</code> for details. | ||
| * | ||
| * For the <code>executionIndexed</code> level of processing, note that indexing | ||
| * information will not be available for unloaded parts of the recording | ||
| * (see <code>Session.listenForLoadChanges</code>) even after processing | ||
| * completes. If processing completes and a <code>Session.loadRegion</code> | ||
| * command is sent, this command can be sent again to wait until indexing of | ||
| * the newly loaded region completes. | ||
| */ | ||
@@ -334,3 +341,5 @@ "Session.ensureProcessed": { | ||
| * earlier loaded regions may be unloaded to reduce backend resource usage. | ||
| * Pauses cannot be created or used in unloaded parts of the recording. | ||
| * Pauses cannot be created or used in unloaded parts of the recording, | ||
| * and information from the <code>executionIndexed</code> processing Level | ||
| * will not be available. | ||
| */ | ||
@@ -683,2 +692,6 @@ "Session.listenForLoadChanges": { | ||
| * Get the points of all steps that are executed by a frame. | ||
| * | ||
| * If this is a generator frame then steps from all places where the frame | ||
| * executed will be returned, except in parts of the recording are unloaded | ||
| * (see <code>Session.listenForLoadChanges</code>). | ||
| */ | ||
@@ -880,3 +893,4 @@ "Pause.getFrameSteps": { | ||
| * Does not return until the analysis has finished and all events have been | ||
| * emitted. | ||
| * emitted. Results will not be gathered in parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -906,2 +920,4 @@ "Analysis.runAnalysis": { | ||
| * are found. Does not return until events for all points have been emitted. | ||
| * Points will not be emitted for parts of the recording that are | ||
| * unloaded, see <code>Session.listenForLoadChanges</code>. | ||
| */ | ||
@@ -908,0 +924,0 @@ "Analysis.findAnalysisPoints": { |
@@ -40,2 +40,10 @@ import { SessionId } from "./Session"; | ||
| /** | ||
| * An execution point and its associated time stamp. Recordings always have a | ||
| * beginning execution point with value "0" and a time stamp of zero. | ||
| */ | ||
| export interface TimeStampedPointRange { | ||
| begin: TimeStampedPoint; | ||
| end: TimeStampedPoint; | ||
| } | ||
| /** | ||
| * A mouse event that occurs somewhere in a recording. | ||
@@ -42,0 +50,0 @@ */ |
@@ -1,2 +0,2 @@ | ||
| import { TimeRange, MouseEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording"; | ||
| import { TimeRange, TimeStampedPointRange, MouseEvent, Annotation, TimeStampedPoint, ExecutionPoint } from "./Recording"; | ||
| import { PauseId, CallStack, PauseData } from "./Pause"; | ||
@@ -117,3 +117,3 @@ /** | ||
| */ | ||
| regions: TimeRange[]; | ||
| regions: TimeStampedPointRange[]; | ||
| } | ||
@@ -137,10 +137,10 @@ /** | ||
| /** | ||
| * Regions which are fully loaded. | ||
| * Timespans which are fully loaded. | ||
| */ | ||
| loaded: TimeRange[]; | ||
| loaded: TimeStampedPointRange[]; | ||
| /** | ||
| * Regions which are in the process of loading. Pauses in these regions | ||
| * Timespans which are in the process of loading. Pauses in these regions | ||
| * can still be used, but will be slower. | ||
| */ | ||
| loading: TimeRange[]; | ||
| loading: TimeStampedPointRange[]; | ||
| } |
| { | ||
| "name": "@recordreplay/protocol", | ||
| "version": "0.8.2", | ||
| "version": "0.9.0", | ||
| "description": "Definition of the protocol used by the Record Replay web service", | ||
@@ -5,0 +5,0 @@ "author": "", |
New alerts
License Policy Violation
LicenseThis 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
LicenseThis 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
- increased by1.82%
203276
- Lines of code
- increased by1.09%
5199