docs: document Table.add progress callback (TypeScript)#243
Open
mintlify[bot] wants to merge 2 commits into
Open
docs: document Table.add progress callback (TypeScript)#243mintlify[bot] wants to merge 2 commits into
mintlify[bot] wants to merge 2 commits into
Conversation
Contributor
Author
|
Preview deployment for your docs. Learn more about Mintlify Previews.
|
prrao87
added
the
needs_new_release
|
|
||
| A few things to know before you wire this up: | ||
|
|
||
| - Non-blocking: if your callback is slow, intermediate updates may be dropped so the write doesn't stall. The final `done: true` callback is always delivered. |
Contributor
There was a problem hiding this comment.
a slow callback will queue events rather than back-pressure the writer, they shouldn't be dropped
brendanclement
requested changes
May 19, 2026
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Documents the new optional
progresscallback onTable.add()in the TypeScript SDK, which surfaces per-batch write progress for long-running ingests.Changes
WriteProgressfields (outputRows,outputBytes,totalRows,elapsedSeconds,activeTasks,totalTasks,done), when callbacks fire, and the non-blocking/error-swallowing semantics.table.add().Context
Upstream PR adds an optional
progresscallback toTable.add(data, { progress })in the Node.js SDK. The callback fires once per batch and once more withdone: trueon completion; errors thrown from user callbacks are logged and swallowed so they don't abort the write.