Type alias Options

Options: Pick<RequestOptions, "headers" | "auth" | "agent" | "timeout" | "maxHeaderSize"> & {
    extractFilename?: boolean;
    maxRedirects?: number;
    name?: string;
    path?: string;
}

Type declaration

  • Optional extractFilename?: boolean

    Boolean indicating whether the image filename will be automatically extracted from url or not. Set to false to have options.path without a file extension for example.

    Default

    true
  • Optional maxRedirects?: number

    The maximum number of allowed redirects; if exceeded, an error will be emitted.

    Default

    21
  • Optional name?: string

    The file name to use, by default it will extract the file name

  • Optional path?: string

    THe file path to use

Settings

Member Visibility

Theme

Generated using TypeDoc