sips-js-api
    Preparing search index...

    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): Size;
    }
    Index
    arguments images longestEdge outputPath size
    requestedSizeForSize
    arguments: string[]

    Arguments passed into the program as an array of strings.

    images: Image[]

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

    longestEdge: number

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

    outputPath: string

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

    undefined

    size: Size

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

    • Internal

      Parameters

      Returns Size

    Settings
    Member Visibility

    On This Page
    Properties
    Methods