Function: validateCmcdRequest()

function validateCmcdRequest(request, options?): CmcdDataValidationResult;

Defined in: validateCmcdRequest.ts:41

Validates CMCD data from a request as a request-mode payload.

Accepts a Request object or an HttpRequest object.

The function checks the HTTP headers for CMCD data first. If the request has CMCD headers, validateCmcdHeaders validates them, including shard placement. Otherwise, the function validates the CMCD query parameter of the URL. A request with CMCD data in both the headers and the CMCD query parameter is an error. The function still validates the headers and returns their data.

Parameters

request

Request | HttpRequest

A Request or HttpRequest to validate.

options?

Omit<CmcdValidationOptions, "reportingMode">

Validation options (excluding reportingMode).

Returns

CmcdDataValidationResult

The validation result including decoded data.

Example

const request = new Request('https://cdn.example.com/seg.mp4', {
	headers: {
		'CMCD-Object': 'br=3000,d=4004',
		'CMCD-Request': 'bl=21600',
	},
})

const result = validateCmcdRequest(request)
equal(result.valid, true)
deepStrictEqual(result.issues, [])

See

CTA-5004-B Request Mode