Interface DatapackExportOptions

Cancellation token that can be used to cancel the export process. When the token is cancelled the export process will stop exporting new objects and throw a CancellationError to indicate that the process was cancelled.

The number of IDs to export in a single chunk when exporting multiple objects. Increase this to reduce the number of API calls when exporting large numbers of objects, or decrease it to reduce memory usage as the exporter accumulates the whole chunk in memory before releasing it. The default is 200.

When set to true the export process will throw an error when an object cannot be exported instead of just logging a warning and skipping the object. This can be used to fail fast when required objects are missing or cannot be exported for some reason. When set to false the exporter will try to continue exporting other objects even when some objects fail to export.

Callback that is called when the export process makes progress exporting objects. This can be used to report progress back to the caller.

Called once per export chunk with the fully resolved datapacks of that chunk, after which the chunk's datapacks are released from memory. Use this to expand/write datapacks incrementally instead of accumulating the whole export. When provided, exportObject streams results through this callback and resolves to an empty array instead of accumulating them.