This repository has been archived by the owner on Sep 3, 2021. It is now read-only.
feat: expose codec code and allow construction by code #118
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
|
@Gozala would appreciate some focused eyes on my flow and TS changes, I think you might have more of a clue than me on both of those |
|
squashed and rebased to master |
vmx
approved these changes
Aug 4, 2020
Gozala
reviewed
Aug 4, 2020
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
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.
(this PR assumes #117, review should focus only on the HEAD commit please, c043bc5)
Ref: #117 (comment)
The idea here is that js-multiformats is going to require a switch to using the multicodec integer code rather than string, which does away with the need to bundle the entire multicodec table (and if you want string and you're happy to have the table then that's fine but you get to choose that). Experience shows that this is the most painful compatibility problem when switching between this library and
multiformats.CID(and vice versa). Having a constructor that can take (optionally) an integer code rather than a string makes it the same constructor asmultiformats.CIDand exposing thecodeproperty makes it the same interface. So we can write new code that works againstCIDandmultiformats.CIDwithout having to worry too much. TheasCID()will be icing on the cake too.As long as we're getting an awkward breaking change into the code, we may as well make sure that anyone who has that code also has this and there's not an in-between state where there's breaking code and then there's this feature out there and you may have one and not the other. Basically it'd be nice to have this out in the wild ASAP to ease future transition and the current breaking change release seems like a good mechanism to force that.