@memlab/api 1.0.0 → 1.0.3

package/dist/__tests__/API/E2EResultReader.test.js

@@ -0,0 +1,72 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+/* eslint-disable @typescript-eslint/ban-ts-comment */
+const fs_1 = __importDefault(require("fs"));
+const BrowserInteractionResultReader_1 = __importDefault(require("../../result-reader/BrowserInteractionResultReader"));
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("./lib/E2ETestSettings");
+beforeEach(E2ETestSettings_1.testSetup);
+function inject() {
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        const arr = [];
+        for (let i = 0; i < 10000; ++i) {
+            arr.push('duplicated string value' + (i % 1));
+        }
+        // @ts-ignore
+        window.__injectedValue = arr;
+    };
+}
+function checkResultReader(result) {
+    const workDir = result.getRootDirectory();
+    expect(fs_1.default.existsSync(workDir)).toBe(true);
+    const snapshotDir = result.getSnapshotFileDir();
+    expect(fs_1.default.existsSync(snapshotDir)).toBe(true);
+    const snapshotFiles = result.getSnapshotFiles();
+    expect(snapshotFiles.length > 0).toBe(true);
+    const steps = result.getInteractionSteps();
+    expect(steps.length > 0).toBe(true);
+    expect(steps[0].name).toBe('page-load');
+    const runMeta = result.getRunMetaInfo();
+    expect(runMeta.app).toBe('test-spa');
+    result.cleanup();
+    expect(fs_1.default.existsSync(workDir)).toBe(false);
+    expect(() => result.getRootDirectory()).toThrowError();
+    expect(() => result.getSnapshotFileDir()).toThrowError();
+    expect(() => result.getSnapshotFiles()).toThrowError();
+}
+test('result data/file reader is working as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    checkResultReader(result);
+}), E2ETestSettings_1.testTimeout);
+test('ResultReader.from is working as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    checkResultReader(BrowserInteractionResultReader_1.default.from(result.getRootDirectory()));
+}), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2ERunSingleSnapshot.example.js

@@ -17,22 +17,21 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
-const path_1 = __importDefault(require("path"));
 const index_1 = require("../../index");
 const scenario = {
     app: () => 'test-spa',
     url: () => '',
     action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
 };
-const promise = (0, index_1.run)({
-    scenario,
-});
-promise.then(result => {
-    const analysis = new index_1.StringAnalysis();
-    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
-    analysis.analyzeSnapshotFromFile(snapshotFile);
-});
+function test() {
+    return __awaiter(this, void 0, void 0, function* () {
+        const result = yield (0, index_1.warmupAndTakeSnapshots)({
+            scenario,
+        });
+        const analysis = new index_1.StringAnalysis();
+        const snapshotFile = result.getSnapshotFiles().pop();
+        analysis.analyzeSnapshotFromFile(snapshotFile);
+    });
+}
+test();

package/dist/__tests__/API/E2EShapeUnboundGrowthAnalysis.test.js

@@ -17,12 +17,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-const path_1 = __importDefault(require("path"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
@@ -44,29 +40,24 @@ function inject() {
 test('Shape unbound analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
     const repeatScenario = Object.assign({ repeat: () => 2 }, E2ETestSettings_1.scenario);
     // test analysis from auto loading
-    const result = yield (0, index_1.run)({
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
         scenario: repeatScenario,
         evalInBrowserAfterInitLoad: inject,
         snapshotForEachStep: true,
     });
     // test analysis from auto loading
     let analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    let shapeSummary = yield analysis.run();
+    yield analysis.run();
+    let shapeSummary = analysis.getShapesWithUnboundGrowth();
     expect(shapeSummary.reduce((acc, summary) => acc || summary.shape.includes('LeakObject'), false)).toBe(true);
     // test analysis from file
-    const snapshotDir = path_1.default.join(result.config.curDataDir);
+    const snapshotDir = result.getSnapshotFileDir();
     analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    shapeSummary = yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
+    yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
+    shapeSummary = analysis.getShapesWithUnboundGrowth();
     expect(shapeSummary.some((summary) => summary.shape.includes('LeakObject'))).toBe(true);
     // expect incorrect use of heap analysis to throw
-    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.ShapeUnboundGrowthAnalysis();
-    let isThrow = false;
-    try {
-        yield analysis.analyzeSnapshotFromFile(snapshotFile);
-    }
-    catch (ex) {
-        isThrow = true;
-    }
-    expect(isThrow).toBe(true);
+    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotFromFile(snapshotFile); })).rejects.toThrowError();
 }), E2ETestSettings_1.testTimeout);

package/dist/__tests__/API/E2EStringAnalysis.test.js

@@ -17,12 +17,8 @@ var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, ge
         step((generator = generator.apply(thisArg, _arguments || [])).next());
     });
 };
-var __importDefault = (this && this.__importDefault) || function (mod) {
-    return (mod && mod.__esModule) ? mod : { "default": mod };
-};
 Object.defineProperty(exports, "__esModule", { value: true });
 /* eslint-disable @typescript-eslint/ban-ts-comment */
-const path_1 = __importDefault(require("path"));
 const index_1 = require("../../index");
 const E2ETestSettings_1 = require("./lib/E2ETestSettings");
 beforeEach(E2ETestSettings_1.testSetup);
@@ -38,7 +34,10 @@ function inject() {
     };
 }
 test('String analysis works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
-    const result = yield (0, index_1.run)({ scenario: E2ETestSettings_1.scenario, evalInBrowserAfterInitLoad: inject });
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
     // test analysis from auto loading
     let analysis = new index_1.StringAnalysis();
     yield analysis.run();
@@ -46,21 +45,26 @@ test('String analysis works as expected', () => __awaiter(void 0, void 0, void 0
     expect(dupStrings[0].n).toBe(10000);
     expect(dupStrings[0].str).toBe('duplicated string value0');
     // test analysis from file
-    const snapshotFile = path_1.default.join(result.config.curDataDir, 's3.heapsnapshot');
+    const snapshotFile = result.getSnapshotFiles().pop();
     analysis = new index_1.StringAnalysis();
     yield analysis.analyzeSnapshotFromFile(snapshotFile);
     dupStrings = analysis.getTopDuplicatedStringsInCount();
     expect(dupStrings[0].n).toBe(10000);
     expect(dupStrings[0].str).toBe('duplicated string value0');
     // expect incorrect use of heap analysis to throw
-    const snapshotDir = result.config.curDataDir;
+    const snapshotDir = result.getSnapshotFileDir();
     analysis = new index_1.StringAnalysis();
-    let isThrow = false;
-    try {
-        yield analysis.analyzeSnapshotsInDirectory(snapshotDir);
-    }
-    catch (ex) {
-        isThrow = true;
-    }
-    expect(isThrow).toBe(true);
+    expect(() => __awaiter(void 0, void 0, void 0, function* () { return yield analysis.analyzeSnapshotsInDirectory(snapshotDir); })).rejects.toThrowError();
+}), E2ETestSettings_1.testTimeout);
+test('analyze function works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const result = yield (0, index_1.warmupAndTakeSnapshots)({
+        scenario: E2ETestSettings_1.scenario,
+        evalInBrowserAfterInitLoad: inject,
+    });
+    // test analysis from auto loading
+    const analysis = new index_1.StringAnalysis();
+    yield (0, index_1.analyze)(result, analysis);
+    const dupStrings = analysis.getTopDuplicatedStringsInCount();
+    expect(dupStrings[0].n).toBe(10000);
+    expect(dupStrings[0].str).toBe('duplicated string value0');
 }), E2ETestSettings_1.testTimeout);

package/dist/__tests__/packages/heap-analysis.test.d.ts

@@ -0,0 +1,11 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+export {};
+//# sourceMappingURL=heap-analysis.test.d.ts.map

package/dist/__tests__/packages/heap-analysis.test.js

@@ -0,0 +1,82 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __awaiter = (this && this.__awaiter) || function (thisArg, _arguments, P, generator) {
+    function adopt(value) { return value instanceof P ? value : new P(function (resolve) { resolve(value); }); }
+    return new (P || (P = Promise))(function (resolve, reject) {
+        function fulfilled(value) { try { step(generator.next(value)); } catch (e) { reject(e); } }
+        function rejected(value) { try { step(generator["throw"](value)); } catch (e) { reject(e); } }
+        function step(result) { result.done ? resolve(result.value) : adopt(result.value).then(fulfilled, rejected); }
+        step((generator = generator.apply(thisArg, _arguments || [])).next());
+    });
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const heap_analysis_1 = require("@memlab/heap-analysis");
+const index_1 = require("../../index");
+const E2ETestSettings_1 = require("../API/lib/E2ETestSettings");
+const API_1 = require("../../API");
+beforeEach(E2ETestSettings_1.testSetup);
+function injectTestObject() {
+    class TestObject {
+    }
+    // @ts-ignore
+    window.injectHookForLink4 = () => {
+        // @ts-ignore
+        const arr = (window.__injectedValue = window.__injectedValue || []);
+        arr.push(new TestObject());
+    };
+}
+const selfDefinedScenario = {
+    app: () => 'test-spa',
+    url: () => '',
+    action: (page) => __awaiter(void 0, void 0, void 0, function* () { return yield page.click('[data-testid="link-4"]'); }),
+    repeat: () => 3,
+};
+class ExampleAnalysis extends heap_analysis_1.BaseAnalysis {
+    constructor() {
+        super(...arguments);
+        this.isMonotonicIncreasing = false;
+    }
+    getCommandName() {
+        return 'example-analysis';
+    }
+    getDescription() {
+        return 'an example analysis for demo';
+    }
+    process(options) {
+        return __awaiter(this, void 0, void 0, function* () {
+            // check if the number of TestObject keeps growing overtime
+            this.isMonotonicIncreasing = yield (0, heap_analysis_1.snapshotMapReduce)(heap => {
+                let cnt = 0;
+                heap.nodes.forEach(node => {
+                    if (node.name === 'TestObject' && node.type === 'object') {
+                        ++cnt;
+                    }
+                });
+                return cnt;
+            }, nodeCounts => nodeCounts[0] === 0 &&
+                nodeCounts[nodeCounts.length - 1] === 4 &&
+                nodeCounts.every((count, i) => i === 0 || count >= nodeCounts[i - 1]), options);
+        });
+    }
+}
+test('snapshotMapReduce works as expected', () => __awaiter(void 0, void 0, void 0, function* () {
+    const results = yield (0, API_1.takeSnapshots)({
+        scenario: selfDefinedScenario,
+        evalInBrowserAfterInitLoad: injectTestObject,
+        snapshotForEachStep: true,
+    });
+    let analysis = new ExampleAnalysis();
+    yield (0, index_1.analyze)(results, analysis);
+    expect(analysis.isMonotonicIncreasing).toBe(true);
+    analysis = new ExampleAnalysis();
+    yield analysis.analyzeSnapshotsInDirectory(results.getSnapshotFileDir());
+    expect(analysis.isMonotonicIncreasing).toBe(true);
+}), E2ETestSettings_1.testTimeout);

package/dist/index.d.ts

@@ -9,5 +9,8 @@
  */
 export * from './API';
 export * from '@memlab/heap-analysis';
+export { default as BrowserInteractionResultReader } from './result-reader/BrowserInteractionResultReader';
+export { dumpNodeHeapSnapshot, getCurrentNodeHeap } from '@memlab/core';
+/** @internal */
 export { config } from '@memlab/core';
 //# sourceMappingURL=index.d.ts.map

package/dist/index.js

@@ -22,9 +22,18 @@ var __createBinding = (this && this.__createBinding) || (Object.create ? (functi
 var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.config = void 0;
+exports.config = exports.getCurrentNodeHeap = exports.dumpNodeHeapSnapshot = exports.BrowserInteractionResultReader = void 0;
 __exportStar(require("./API"), exports);
 __exportStar(require("@memlab/heap-analysis"), exports);
+var BrowserInteractionResultReader_1 = require("./result-reader/BrowserInteractionResultReader");
+Object.defineProperty(exports, "BrowserInteractionResultReader", { enumerable: true, get: function () { return __importDefault(BrowserInteractionResultReader_1).default; } });
 var core_1 = require("@memlab/core");
-Object.defineProperty(exports, "config", { enumerable: true, get: function () { return core_1.config; } });
+Object.defineProperty(exports, "dumpNodeHeapSnapshot", { enumerable: true, get: function () { return core_1.dumpNodeHeapSnapshot; } });
+Object.defineProperty(exports, "getCurrentNodeHeap", { enumerable: true, get: function () { return core_1.getCurrentNodeHeap; } });
+/** @internal */
+var core_2 = require("@memlab/core");
+Object.defineProperty(exports, "config", { enumerable: true, get: function () { return core_2.config; } });

package/dist/result-reader/BaseResultReader.d.ts

@@ -0,0 +1,70 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import { FileManager } from '@memlab/core';
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from
+ * a memlab run
+ */
+export default class BaseResultReader {
+    protected workDir: string;
+    protected fileManager: FileManager;
+    private isValid;
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     */
+    protected constructor(workDir?: string);
+    protected check(): void;
+    /**
+     * internal
+     * @param workDir
+     * @returns
+     */
+    static from(workDir?: string): BaseResultReader;
+    /**
+     * get the directory where the data and generated files of
+     * the memlab run were stored
+     * @returns absolute path of the directory
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get the directory that stores all the files
+     *   // generated from the takeSnapshots call
+     *   const dataDir = result.getRootDirectory();
+     * })();
+     * ```
+     */
+    getRootDirectory(): string;
+    /**
+     * clean up data/files generated from the memlab browser interaction run
+     * @returns no return value
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // delete all data/files generated by takeSnapshots
+     *   result.cleanup();
+     * })();
+     * ```
+     */
+    cleanup(): void;
+}
+//# sourceMappingURL=BaseResultReader.d.ts.map

package/dist/result-reader/BaseResultReader.js

@@ -0,0 +1,96 @@
+"use strict";
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+var __importDefault = (this && this.__importDefault) || function (mod) {
+    return (mod && mod.__esModule) ? mod : { "default": mod };
+};
+Object.defineProperty(exports, "__esModule", { value: true });
+const core_1 = require("@memlab/core");
+const fs_extra_1 = __importDefault(require("fs-extra"));
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from
+ * a memlab run
+ */
+class BaseResultReader {
+    /**
+     * build a result reader
+     * @param workDir absolute path of the directory where the data
+     * and generated files of the memlab run were stored
+     */
+    constructor(workDir = '') {
+        this.fileManager = new core_1.FileManager();
+        if (workDir === '') {
+            workDir = this.fileManager.getWorkDir();
+        }
+        this.workDir = workDir;
+        this.check();
+    }
+    check() {
+        this.isValid = fs_extra_1.default.existsSync(this.workDir);
+        if (!this.isValid) {
+            core_1.utils.haltOrThrow(`invalid/removed data directory: ${this.workDir}`);
+        }
+    }
+    /**
+     * internal
+     * @param workDir
+     * @returns
+     */
+    static from(workDir = '') {
+        return new BaseResultReader(workDir);
+    }
+    /**
+     * get the directory where the data and generated files of
+     * the memlab run were stored
+     * @returns absolute path of the directory
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get the directory that stores all the files
+     *   // generated from the takeSnapshots call
+     *   const dataDir = result.getRootDirectory();
+     * })();
+     * ```
+     */
+    getRootDirectory() {
+        this.check();
+        return this.workDir;
+    }
+    /**
+     * clean up data/files generated from the memlab browser interaction run
+     * @returns no return value
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // delete all data/files generated by takeSnapshots
+     *   result.cleanup();
+     * })();
+     * ```
+     */
+    cleanup() {
+        if (!this.isValid) {
+            return;
+        }
+        fs_extra_1.default.removeSync(this.workDir);
+        this.isValid = false;
+    }
+}
+exports.default = BaseResultReader;

package/dist/result-reader/BrowserInteractionResultReader.d.ts

@@ -0,0 +1,105 @@
+/**
+ * Copyright (c) Meta Platforms, Inc. and affiliates.
+ *
+ * This source code is licensed under the MIT license found in the
+ * LICENSE file in the root directory of this source tree.
+ *
+ * @emails oncall+ws_labs
+ * @format
+ */
+import type { E2EStepInfo, RunMetaInfo } from '@memlab/core';
+import BaseResultReader from './BaseResultReader';
+/**
+ * A utility entity to read all generated files from
+ * the directory holding the data and results from the
+ * last browser interaction run
+ */
+export default class BrowserInteractionResultReader extends BaseResultReader {
+    /**
+     * build a result reader from a data directory where the data
+     * and generated files of a memlab run were stored
+     * @param workDir absolute path of the data directory
+     * @returns the ResultReader instance
+     *
+     * * **Examples**:
+     * ```javascript
+     * const {BrowserInteractionResultReader} = require('@memlab/api');
+     *
+     * const dataDir = '/tmp/memlab'; // where the last memlab run stores results
+     * const reader = BrowserInteractionResultReader.from(dataDir);
+     * reader.cleanup(); // clean up the results
+     * ```
+     */
+    static from(workDir?: string): BrowserInteractionResultReader;
+    /**
+     * get all snapshot files generated from last memlab browser interaction
+     * @returns an array of snapshot file's absolute path
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get absolute paths of all snapshot files
+     *   const files = result.getSnapshotFiles();
+     * })();
+     * ```
+     */
+    getSnapshotFiles(): string[];
+    /**
+     * get the directory holding all snapshot files
+     * @returns the absolute path of the directory
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   // get the absolute path the directory holding all snapshot files
+     *   const files = result.getSnapshotFileDir();
+     * })();
+     * ```
+     */
+    getSnapshotFileDir(): string;
+    /**
+     * browser interaction step sequence
+     * @returns an array of browser interaction step information
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   const steps = result.getInteractionSteps();
+     *   // print each browser interaction's name and JavaScript heap size (in bytes)
+     *   steps.forEach(step => console.log(step.name, step.JSHeapUsedSize))
+     * })();
+     * ```
+     */
+    getInteractionSteps(): E2EStepInfo[];
+    /**
+     * general meta data of the browser interaction run
+     * @returns meta data about the entire browser interaction
+     * * **Examples**:
+     * ```javascript
+     * const {takeSnapshots} = require('@memlab/api');
+     *
+     * (async function () {
+     *   const scenario = { url: () => 'https://www.npmjs.com'};
+     *   const result = await takeSnapshots({scenario});
+     *
+     *   const metaInfo = result.getRunMetaInfo();
+     *   // print all browser web console output
+     *   console.log(metaInfo.browserInfo._consoleMessages.join('\n'));
+     * })();
+     * ```
+     */
+    getRunMetaInfo(): RunMetaInfo;
+}
+//# sourceMappingURL=BrowserInteractionResultReader.d.ts.map