chore: fix cleanupOlderThan docs (#2504)

Thanks for all your work.

The docstring for `OptimizeOptions ` seems to reference a non-existent
method on `Table`. I believe this is the correct example for
`cleanupOlderThan`.

This also appears in the generated docs, but I assume they live
downstream from this code?
This commit is contained in:
Benjamin Schmidt
2025-07-15 04:23:10 -04:00
committed by GitHub
parent 6d23d32ab5
commit 4c999fb651

View File

@@ -75,10 +75,10 @@ export interface OptimizeOptions {
* // Delete all versions older than 1 day
* const olderThan = new Date();
* olderThan.setDate(olderThan.getDate() - 1));
* tbl.cleanupOlderVersions(olderThan);
* tbl.optimize({cleanupOlderThan: olderThan});
*
* // Delete all versions except the current version
* tbl.cleanupOlderVersions(new Date());
* tbl.optimize({cleanupOlderThan: new Date()});
*/
cleanupOlderThan: Date;
deleteUnverified: boolean;