Interface GetObjectOptions

Options for getting an object.

interface GetObjectOptions {
    bucket: string;
    filename?: string;
    key: string;
}

Properties

bucket: string

The bucket from which to acquire the file.

filename?: string

The suggested name for the file once it's downloaded/saved. Note: the string is cleaned to ensure maximum compatibility with every OS.

key: string

The complete filepath (within the bucket) from which to acquire the file.