Interface Configuration

The Configuration interface contains various information about the current process.

interface Configuration {
    arguments: string[];
    images: Image[];
    longestEdge: number;
    outputPath: string;
    size: Size;
    requestedSizeForSize(size): Size;
}

Properties

arguments images longestEdge outputPath size

Methods

requestedSizeForSize

Properties

Readonly arguments

arguments: string[]

Arguments passed into the program as an array of strings.

Readonly images

images: Image[]

Valid images passed as arguments converted into an array of Image objects.

Readonly longestEdge

longestEdge: number

If specified, the value of the -Z or --resampleHeightWidthMax option. [default: 0]

Readonly outputPath

outputPath: string

The full path of the output directory specified with -o or --out option.

Default Value

undefined

Readonly size

size: Size

Recommended size for output. Setting the crop or resample flags will set this value.

Methods

requestedSizeForSize

  • requestedSizeForSize(size): Size
  • Internal

    Parameters

    Returns Size

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc