Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ImageService

Image table service.

Hierarchy

  • ImageService

Index

Constructors

Methods

Constructors

constructor

Methods

createImage

  • createImage(data: string): Promise<NBImage>

deleteImage

  • deleteImage(imageID: string): Promise<void>

getImage

  • getImage(imageID: string): Promise<NBImage>

imageExists

  • imageExists(imageID: string): Promise<boolean>

  • Determine whether or not an image exists.

    Parameters

    • imageID: string

      The ID of the image.

    Returns Promise<boolean>

    Whether or not the image exists.

setImageData

  • setImageData(imageID: string, newData: string): Promise<NBImage>

Private shrinkImage

  • shrinkImage(image: Buffer, factor: number, quality?: number): Promise<Buffer>

  • Shrink an image.

    Parameters

    • image: Buffer

      The image buffer.

    • factor: number

      The scale factor.

    • quality: number = 100

      The JPEG quality.

    Returns Promise<Buffer>

    The resulting image buffer.

Private shrinkImageAuto

  • shrinkImageAuto(image: Buffer, maxImageSize: number, maxWidth?: number, maxHeight?: number, factor?: number, quality?: number): Promise<Buffer>

  • Shrink an image automatically.

    Parameters

    • image: Buffer

      The image buffer.

    • maxImageSize: number

      The maximum size of the image.

    • maxWidth: number = 1600

      The maximum width of the image.

    • maxHeight: number = 900

      The maximum height of the image.

    • factor: number = 0.7071

      The scale factor.

    • quality: number = 40

      The JPEG quality.

    Returns Promise<Buffer>

    The resulting image buffer.

Private shrinkImageAutoBase64

  • shrinkImageAutoBase64(imageB64: string, maxWidth?: number, maxHeight?: number, factor?: number, quality?: number): Promise<string>

  • Shrinks a base64 encoded image automatically.

    Parameters

    • imageB64: string

      The base64 image.

    • maxWidth: number = 1600

      The maximum width of the image.

    • maxHeight: number = 900

      The maximum height of the image.

    • factor: number = 0.7071

      The scale factor.

    • quality: number = 40

      The JPEG quality.

    Returns Promise<string>

    The shrunk base64 image.

Private shrinkImageToSize

  • shrinkImageToSize(image: Buffer, maxWidth?: number, maxHeight?: number): Promise<Buffer>

  • Shrink an image to a maximum size.

    Parameters

    • image: Buffer

      The image buffer.

    • maxWidth: number = 1920

      The maximum width of the image.

    • maxHeight: number = 1080

      The maximum height of the image.

    Returns Promise<Buffer>

    The resulting image buffer.

Generated using TypeDoc