Class PathInput

filename

Optionalfilepath

inputType

mimeType

applyPageOptions

• applyPageOptions(pageOptions: PageOptions): Promise<void>

  Cut PDF pages.

  Parameters

  • pageOptions: PageOptions

  Returns Promise<void>

checkMimetype

• checkMimetype(): Promise<string>

  Returns Promise<string>

compress

• compress(
      quality?: number,
      maxWidth?: null | number,
      maxHeight?: null | number,
      forceSourceText?: boolean,
      disableSourceText?: boolean,
  ): Promise<void>

  Compresses the file object, either as a PDF or an image.

  Parameters

  • quality: number = 85

    Quality of the compression. For images, this is the JPEG quality. For PDFs, this affects image quality within the PDF.
  • maxWidth: null | number = null

    Maximum width for image resizing. Ignored for PDFs.
  • maxHeight: null | number = null

    Maximum height for image resizing. Ignored for PDFs.
  • forceSourceText: boolean = false

    For PDFs, whether to force compression even if source text is present.
  • disableSourceText: boolean = true

    For PDFs, whether to disable source text during compression.

  Returns Promise<void>

  A Promise that resolves when the compression is complete.

cutPdf

• cutPdf(pageOptions: PageOptions): Promise<void>

  Cut PDF pages.

  Parameters

  • pageOptions: PageOptions

  Returns Promise<void>

  Deprecated

  Deprecated in favor of applyPageOptions().

hasSourceText

• hasSourceText(): Promise<boolean>

  Returns true if the object is a PDF and has source text. False otherwise.

  Returns Promise<boolean>

  boolean

isPdf

• isPdf(): boolean

  Returns boolean