Allow custom CBOR encoding/decoding replacer #387
Conversation
This file contains 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
lkwr
force-pushed
the
lkwr/custom-cbor
branch
from
7b43114 to
5331505
Compare
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.
Thank you for submitting this pull request! We appreciate you spending the time to work on these changes.
What is the motivation?
I'm currently building an ORM/ODM for SurrealDB in TypeScript, which I want to open source soon (hopefully this year). For the underlying connection to the database, I use
surrealdb.js. But types likeRecordIdorTableare reimplemented so I can provide a much deeper integration in the whole library.And there comes the problem: Currently before passing the query to
surrealdb.jsI have a convert step which converts all "custom types" tosurrealdb.jsequivalents. It would be faster and more flexible when I'm able to overwrite the default CBOR encoding/decoding behaviour.What does this change do?
So this PR does exactly that, it provides a way to overwrite the default CBOR encoding/decoding replacer. I also export the default replacer, so its much easier to add custom types on top of the default ones.
What are your thoughts on this?
What is your testing strategy?
--
Is this related to any issues?
--
Have you read the Contributing Guidelines?