Method getBuffer

packages/core/src/index.ts:424–453

* Converts the Jimp instance to an image buffer * @param mime The mime type to export to * @param options The options to use when exporting * @example * ```ts * import { Jimp } from "jimp"; * import { promises as fs } from "fs"; * * const image = new Jimp({ wi

(mime: ProvidedMimeType, options?: Options)

     * ```
     */
    async getBuffer<
      ProvidedMimeType extends SupportedMimeTypes,
      Options extends GetOptionsForMimeType<
        ProvidedMimeType,
        MimeTypeToExportOptions
      >,
    >(mime: ProvidedMimeType, options?: Options) {
      const format = this.formats.find((format) => format.mime === mime);

      if (!format || !format.encode) {
        throw new Error(`Unsupported MIME type: ${mime}`);
      }

      let outputImage: Jimp;

      if (format.hasAlpha) {
        // eslint-disable-next-line @typescript-eslint/no-this-alias
        outputImage = this;
      } else {
        outputImage = new CustomJimp({
          width: this.bitmap.width,
          height: this.bitmap.height,
          color: this.background,
        });

        composite(outputImage, this);
      }

      return format.encode(outputImage.bitmap, options);
    }

    /**
     * Converts the image to a base 64 string