@flyyer/flyyer-lite/dist/meta.d.ts

Flyyer.io helper classes and methods to generate smart URL to render images.

/**
 * Meta variables usually have values assigned by Flyyer depending on how and where images are rendered.
 *
 * You can force these values here.
 * @example
 * const meta: FlyyerMetaVariables ={
 *   width: 1080, // in pixels
 *   height: 1080, // in pixels
 *   v: null, // disable cache-burst
 *   id: "my-id", // analytics id
 * }
 * const flyyerRender = new FlyyerRender({ meta });
 * const flyyer = new Flyyer({ meta });
 * @example
 * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?__v=disabled`
 * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?_w=1080&_h=1080`
 * `https://cdn.flyyer.io/v2/flyyer-com/_/_/?__v=disabled`
 * `https://cdn.flyyer.io/v2/flyyer-com/_/_w=1080&_h=1080/marketplace`
 */
export interface FlyyerMetaVariables {
    /**
     * Force crawler user agent.
     * Converted to `_ua=` on `flyyer.href()` if set.
     *
     * Full list at https://docs.flyyer.io/docs/features/agent-detection
     * @example
     * "whatsapp" // _ua=whatsapp
     * "facebook" // _ua=facebook
     * "twitter" // _ua=twitter
     * "instagram" // _ua=instagram
     */
    agent?: string | undefined | null;
    locale?: string | undefined | null;
    /**
     * Pixels (integer value).
     * Converted to `_w=` on `flyyer.href()` if set.
     * @example
     * 1200 // _w=1200 // default value most of the time
     * 1080 // _w=1080
     * @example
     * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?_w=1080&_h=1080`
     * `https://cdn.flyyer.io/v2/flyyer-com/_/_w=1080&_h=1080/jobs`
     */
    width?: string | number | undefined | null;
    /**
     * Pixels (integer value).
     * Converted to `_h=` on `flyyer.href()` if set.
     * @example
     * 1200 // _h=630 // default value most of the time
     * 1080 // _h=1080
     * 1080 // _h=1920
     * @example
     * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?_w=1080&_h=1080`
     * `https://cdn.flyyer.io/v2/flyyer-com/_/_w=1080&_h=1080/jobs`
     */
    height?: string | number | undefined | null;
    /**
     * Range from [0.0, 1.0]
     * Converted to `_res=` on `flyyer.href()` if set.
     */
    resolution?: string | number | undefined | null;
    /**
     * To identify your links on the analytics report
     * Converted to `__id=` on `flyyer.href()` if set.
     */
    id?: string | number | undefined | null;
    /**
     * Cache invalidator, set to `null` or empty string `""` to disable it.
     * Converted to `__v=` on `flyyer.href()` if set.
     *
     * **If you are using Flyyer inside your website for to render images we recommend disabling it to use browser's cache.**
     * @example
     * const flyyer = new FlyyerRender({ meta: { v: null } }); // disabled
     * @example
     * __v=null // disabled
     * __v="1" // constant
     * undefined|__ // `__v=123123` a timestamp will be used.
     * @example
     * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?title=Hello&__v=123123` // by default is a timestamp
     * `https://cdn.flyyer.io/r/v2/flyyer/default/main.jpeg?title=Hello&__v=` // disabled to use browser's cache
     */
    v?: string | number | null | undefined;
}