Repository navigation
docs: note that this is a fork with an async API - #5
Merged
Merged
Conversation
Add a fork notice at the top of the README linking the upstream superjson repository and this fork, and stating that the package is published to npm as @eridu-tech/superjson. Document the asynchronous public API in a new 'Async API' section: stringify, parse, serialize and deserialize return Promises. Note that the registration methods remain synchronous and that custom transformers may be async. Update the usage examples, which still showed the upstream synchronous calls, to await the async methods. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Update the README install command and the import statements to use the scoped package name, so the documented usage matches the package this fork publishes. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.com>
Add a fork notice at the top of the README linking the upstream superjson repository and this fork, and stating that the package is published to npm as @eridu-tech/superjson. Document the asynchronous public API in a new 'Async API' section: stringify, parse, serialize and deserialize return Promises. Note that the registration methods remain synchronous and that custom transformers may be async. Update the usage examples, which still showed the upstream synchronous calls, to await the async methods. Co-authored-by: Copilot <223556219+Copilot@users.noreply.github.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
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.
Updates the README for the
@eridu-tech/superjsonfork.What changed
> [!IMPORTANT]alert) linking the upstream blitz-js/superjson and this repository, and stating the npm package nameAsync APIsection documenting thatstringify,parse,serializeanddeserializereturn Promises, that the registration methods remain synchronous, and that custom transformers may be asyncawaitthe async methods (Basic Usage, Advanced Usage and the API section)Not included
The install instructions (
yarn add superjson), the npm badge and the CI badge still point at the upstream project. Happy to update those in a follow-up if the README should be fully rebranded.Verification
awaited