Skip to content

basalt / storage/src / CopyOptions

Interface: CopyOptions ​

Defined in: storage/src/index.ts:203

Options for Disk.copy.

Extends ​

Properties ​

contentType? ​

> optional contentType?: string

Defined in: storage/src/driver.ts:54

Content type for the destination object; unset keeps the source's.

Inherited from ​

CopyDriverOptions.contentType


disk? ​

> optional disk?: Disk

Defined in: storage/src/index.ts:209

Destination disk. Defaults to the source disk. A different disk on the SAME driver instance still copies server-side; anything else falls back to getStream → putStream (and finally get → put).


maxBytes? ​

> optional maxBytes?: number

Defined in: storage/src/index.ts:215

Cap applied to the fallback copy, which is the only one whose bytes travel through this process. A server-side copy never reads the body, so it cannot be capped here — use it deliberately.


requireServerSide? ​

> optional requireServerSide?: boolean

Defined in: storage/src/index.ts:221

Refuse to fall back: throw CopyUnsupportedError instead of moving the bytes through this process. Use it when a copy that quietly downloads and re-uploads a multi-gigabyte object would be a bug, not a slow path.

Released under the MIT License.