Function toCmcdQuery

toCmcdQuery(cmcd: Cmcd, options?: CmcdEncodeOptions): string

Convert a CMCD object to a query arg.

Parameters

cmcd: Cmcd
The CMCD object to convert.
options: CmcdEncodeOptions = {}
Options for encoding.

Returns string

The CMCD query arg.

See

CTA-5004-B Query Argument Definition

Example

const data = {
	br: [1000],
	'com.example-hello': 'world',
	ec: ['ERR001', 'ERR002'],
	su: true,
}

const options = {
	version: 2 as const,
	reportingMode: CmcdReportingMode.REQUEST,
}

equal(toCmcdQuery(data, options), 'CMCD=br%3D%281000%29%2Ccom.example-hello%3D%22world%22%2Cec%3D%28%22ERR001%22%20%22ERR002%22%29%2Csu%2Cv%3D2')