Skip to main content

Class: ObjectShapeAnalysis

Defined in: heap-analysis/src/plugins/ObjectShapeAnalysis.ts:34

Extends​

Constructors​

Constructor​

new ObjectShapeAnalysis(): ObjectShapeAnalysis

Returns​

ObjectShapeAnalysis

Inherited from​

BaseAnalysis.constructor

Methods​

analyzeSnapshotFromFile()​

analyzeSnapshotFromFile(file, options?): Promise\<AnalyzeSnapshotResult>

Defined in: heap-analysis/src/BaseAnalysis.ts:95

Run heap analysis for a single heap snapshot file

Parameters​

file​

string

the absolute path of a .heapsnapshot file.

options?​

RunHeapAnalysisOptions = {}

optional configuration for the heap analysis run

Returns​

Promise\<AnalyzeSnapshotResult>

this API returns AnalyzeSnapshotResult, which contains the logging file of analysis console output. Alternatively, to get more structured analysis results, check out the documentation of the hosting heap analysis class and call the analysis-specific API to get results after calling this method.

  • Example:
const analysis = new StringAnalysis();
// analysis console output is saved in result.analysisOutputFile
const result = await analysis.analyzeSnapshotFromFile(snapshotFile);
// query analysis-specific and structured results
const stringPatterns = analysis.getTopDuplicatedStringsInCount();

Additionally, you can specify a working directory to where the intermediate, logging, and final output files will be dumped:

const analysis = new StringAnalysis();
// analysis console output is saved in result.analysisOutputFile
// which is inside the specified working directory
const result = await analysis.analyzeSnapshotFromFile(snapshotFile, {
  // if the specified directory doesn't exist, memlab will create it
  workDir: '/tmp/your/work/dir',
});

Inherited from​

BaseAnalysis.analyzeSnapshotFromFile

getCommandName()​

getCommandName(): string

Defined in: heap-analysis/src/plugins/ObjectShapeAnalysis.ts:35

Get the name of the heap analysis, which is also used to reference the analysis in memlab command-line tool.

The following terminal command will initiate with this analysis: memlab analyze <ANALYSIS_NAME>

Returns​

string

the name of the analysis

  • Examples:
const analysis = new YourAnalysis();
const name = analysis.getCommandName();

Overrides​

BaseAnalysis.getCommandName