Add TypeScript README and update project README - #53
Merged
Conversation
Also re-export EsqueConfiguration/createEsqueConfiguration from the
package's single entry point (src/esque.ts) so the library usage shown
in the new README actually works via `import { Esque, createEsqueConfiguration } from "esque-ts"`.
Co-Authored-By: Claude Fable 5 <noreply@anthropic.com>
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
1 participant
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
implementations/typescript/README.md, mirroring the existing JVM/Python implementation READMEs (installation, library usage, CLI usage,EsqueConfigurationfields, how-it-works, development commands).README.md's Implementations section to include TypeScript/npm alongside JVM and Python, and fixes leftover "both implementations" language now that there are three.EsqueConfiguration/createEsqueConfigurationfromimplementations/typescript/src/esque.ts(the package's single entry point) so the library-usage example in the new README actually works viaimport { Esque, createEsqueConfiguration } from "esque-ts"— previously onlyEsquewas reachable from the package root.Test plan
npm run typecheck && npm run build— confirmed the new re-exports compile and are importable fromdist/esque.jsnpm run lint && npm test— 56/56 unit tests pass, no regressions🤖 Generated with Claude Code