Function: validateCmcdHeaders()

function validateCmcdHeaders(headers, options?): CmcdDataValidationResult;

Defined in: validateCmcdHeaders.ts:35

Validates CMCD HTTP headers by checking shard placement and payload validity.

This function accepts raw CMCD header strings and decodes each shard internally. It verifies that each key is in its correct header shard. The function then merges all shards and runs payload validation (keys, values, and structure) on the merged data.

Parameters

headers

| Record<string, string> | Headers

A Headers instance or a record of CMCD header fields to raw encoded strings.

options?

Omit<CmcdValidationOptions, "reportingMode">

Validation options (excluding reportingMode).

Returns

CmcdDataValidationResult

The validation result including decoded data.

Example

const result = validateCmcdHeaders({
	'CMCD-Object': 'br=3000,d=4004',
	'CMCD-Request': 'bl=21600',
})
equal(result.valid, true)
deepStrictEqual(result.issues, [])

See

CTA-5004-B Header Field Definition