Skip to content

Fix README examples and JSDoc#9

Merged
Shane98c merged 2 commits intomainfrom
readme-updates
Apr 2, 2026
Merged

Fix README examples and JSDoc#9
Shane98c merged 2 commits intomainfrom
readme-updates

Conversation

@Shane98c
Copy link
Copy Markdown
Collaborator

@Shane98c Shane98c commented Apr 2, 2026

  • Correct README code examples (zarrita open call, new store options, URL translation details, HTTP repo caveats)
  • Fix JSDoc examples in src/index.ts and src/store.ts to use store.resolve()
  • Add integration test for the store.resolve() pattern shown in the README

Copy link
Copy Markdown

@gemini-code-assist gemini-code-assist bot left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Code Review

This pull request updates the README to reflect that the library is pure TypeScript and works in Node.js 18+, while removing specific bundle size and dependency mentions. It also updates documentation and code examples to use the store.resolve() pattern for array access, introduces new IcechunkStore options (signal, validateChecksums, azureAccount), and clarifies cloud storage URL translation. Additionally, it adds a note on v1 repository limitations over HTTP, includes metadata in the history walk example, and adds a corresponding integration test. I have no feedback to provide.

@Shane98c Shane98c merged commit 15d3b0b into main Apr 2, 2026
9 checks passed
@Shane98c Shane98c deleted the readme-updates branch April 2, 2026 15:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant