docs(task-graph): fix TaskOutputTabularRepository README examples for new constructor signature#551
Merged
Merged
Conversation
… new constructor signature After commit c011234 removed the legacy `{ tabularRepository: ... }` option shim, copy-paste from these README examples produced a TS error against the new `{ storage: ITaskOutputStorage }` constructor signature. Replaced the eight stale `tabularRepository:` constructor calls across two READMEs with `storage: tabularTaskOutputStorage(...)` and pulled the helper into each example's import block.
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
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
c011234removed theLegacyTaskOutputRepositoryOptionsshim, soTaskOutputTabularRepository's constructor now only accepts{ storage: ITaskOutputStorage, outputCompression? }. Two READMEs still showed the old{ tabularRepository: ... }form, which would no longer compile when users copy-paste them.TaskOutputTabularRepositoryconstructor calls acrosspackages/task-graph/README.mdandpackages/task-graph/src/storage/README.mdwith the new shape:storage: tabularTaskOutputStorage(<raw tabular storage>). The helpertabularTaskOutputStorageis already exported from@workglow/task-graph(viasrc/storage/TabularTaskOutputStorage.tsre-exported bysrc/common.ts).tabularTaskOutputStorageinto each example's@workglow/task-graphimport block. Left everyTaskGraphTabularRepositoryconstructor untouched — that class still takestabularRepository:.Verification
Test plan
grep -nB1 "tabularRepository:" packages/task-graph/README.md packages/task-graph/src/storage/README.md— every hit is preceded bynew TaskGraphTabularRepository({.packages/task-graphand confirm it type-checks against the currentTaskOutputTabularRepositorysignature.Generated by Claude Code