Function encodeCmcd

encodeCmcd(cmcd: CmcdData, options?: CmcdEncodeOptions): string

Beta

Encode a CMCD object to a string.

Parameters

cmcd: CmcdData
The CMCD object to encode.
options: CmcdEncodeOptions = {}
Options for encoding.

Returns string

The encoded CMCD string.

Example

const input = { br: 1000, 'com.example-hello': 'world', ec: ['ERR001', 'ERR002'], su: true };
const options = { version: 2, reportingMode: CmcdReportingMode.REQUEST };
equal(encodeCmcd(input, options), 'br=1000,com.example-hello="world",ec=("ERR001" "ERR002"),su,v=2');