Type Alias CmcdEncodeOptionsBeta

CmcdEncodeOptions: {
    baseUrl?: string;
    customHeaderMap?: CmcdHeadersMap;
    filter?: ((key: CmcdKey) => boolean);
    formatters?: Record<CmcdKey, CmcdFormatter>;
}

Options for encoding CMCD values.

Type declaration

  • Optional BetabaseUrl?: string

    The base URL to use for relative URLs.

  • Optional BetacustomHeaderMap?: CmcdHeadersMap

    A map of CMCD header fields to custom CMCD keys.

  • Optionalfilter?: ((key: CmcdKey) => boolean)

    A filter function for CMCD keys.

      • (key): boolean
      • Parameters

        • key: CmcdKey

          The CMCD key to filter.

        Returns boolean

        true if the key should be included, false otherwise.

  • Optional Betaformatters?: Record<CmcdKey, CmcdFormatter>

    A map of CMCD keys to custom formatters.