Function: parse()

June 6, 2026 ยท View on GitHub

CTRF


CTRF / parse

Function: parse()

parse(json, options?): CTRFReport

Defined in: parse.ts:33

Parameters

json

string

JSON string to parse

options?

ParseOptions = {}

Parse options (e.g., enable validation)

Returns

CTRFReport

Parsed CTRFReport object

Throws

ParseError if JSON is invalid

Throws

ValidationError if validation is enabled and fails

Example

const report = parse(jsonString);

// With validation
const report = parse(jsonString, { validate: true });