@maizzle/framework/types/urlParameters.d.ts

Maizzle is a framework that helps you quickly build HTML emails with Tailwind CSS.

import type { URLParametersConfig as URLParamsConfig } from 'posthtml-url-parameters';

export default interface URLParametersConfig {
  [key: string]: any;

  _options?: {
    /**
     * Array of tag names to process. Only URLs inside `href` attributes
     * of tags in this array will be processed.
     *
     * @default ['a']
     *
     * @example
     * ```
     * export default {
     *   urlParameters: {
     *     _options: {
     *       tags: ['a[href*="example.com"]'],
     *     },
     *     utm_source: 'maizzle',
     *   }
     * }
     * ```
     */
    tags?: URLParamsConfig['tags'];

    /**
    By default, query parameters are appended only to valid URLs.
    Disable strict mode to append parameters to any string.

    @default true
    */
    strict?: boolean;

    /**
    Options to pass to the `query-string` library.
    */
    qs?: URLParamsConfig['qs'];
  };
}