Type alias BuildOptions

Type declaration

• Optional addExtension?: boolean

  Whether to append the extension (or filetype) to the end of the url.

  Defaults to false. If true adds the extension.

• Optional baseUrl?: string

  The base URL of the imgproxy instance, e.g. https://my-imgproxy.test

• path: string

  The path to the target image, e.g. https://example.com/foo.png

• Optional plain?: boolean

  Whether to append the path in plain.

  Defaults to false. If false, encodes the path to a base64url

• Optional signature?: {
      key: string;
      salt: string;
      size?: number;
  }

  The signature to apply

  • key: string

    The hex-encoded key of the signature

  • salt: string

    The hex encoded salt of the signature

  • Optional size?: number

    The number of bytes to use for the signature before encoding to Base64

    Defaults to 32