kingsword09 commented on code in PR #6312:
URL: https://github.com/apache/opendal/pull/6312#discussion_r2155689344
##########
bindings/nodejs/generated.d.ts:
##########
@@ -74,6 +74,158 @@ export interface StatOptions {
*/
overrideContentDisposition?: string
}
+export interface ReadOptions {
+ /**
+ * Set `version` for this operation.
+ *
+ * This option can be used to retrieve the data of a specified version of the
given path.
+ */
+ version?: string
+ /**
+ * Set `concurrent` for the operation.
+ *
+ * OpenDAL by default to read file without concurrent. This is not efficient
for cases when users
+ * read large chunks of data. By setting `concurrent`, opendal will reading
files concurrently
+ * on support storage services.
+ *
+ * By setting `concurrent`, opendal will fetch chunks concurrently with
+ * the give chunk size.
+ */
+ concurrent?: number
+ /**
+ * Sets the chunk size for this operation.
+ *
+ * OpenDAL will use services' preferred chunk size by default. Users can set
chunk based on their own needs.
+ */
+ chunk?: number
+ /**
+ * Controls the optimization strategy for range reads in [`Reader::fetch`].
+ *
+ * When performing range reads, if the gap between two requested ranges is
smaller than
+ * the configured `gap` size, OpenDAL will merge these ranges into a single
read request
+ * and discard the unrequested data in between. This helps reduce the number
of API calls
+ * to remote storage services.
+ *
+ * This optimization is particularly useful when performing multiple small
range reads
+ * that are close to each other, as it reduces the overhead of multiple
network requests
+ * at the cost of transferring some additional data.
+ */
+ gap?: bigint
+ /**
+ * Sets the offset (starting position) for range read operations.
+ * The read will start from this position in the file.
+ */
+ offset?: bigint
+ /**
+ * Sets the size (length) for range read operations.
+ * The read will continue for this many bytes after the offset.
+ */
+ size?: bigint
Review Comment:
What usage should be applied to this field?
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
To unsubscribe, e-mail: commits-unsubscr...@opendal.apache.org
For queries about this service, please contact Infrastructure at:
us...@infra.apache.org
