Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Release v3.0.0 #75

Closed
hacdias opened this issue Dec 17, 2020 · 1 comment
Closed

Release v3.0.0 #75

hacdias opened this issue Dec 17, 2020 · 1 comment

Comments

@hacdias
Copy link
Member

hacdias commented Dec 17, 2020

Due to the previous breaking changes that were not supposed to have broken the API, I'm creating this issue to make sure we test the recent changes against js-ipfs to make sure that there is no undocumented change.

Release Notes

Features

  • Export top-level tables as part of the API: nameToVarint, nameToCode and codeToName. For those who were importing src/base-table, please use nameToCode now.

Refactor

  • Rename type CodecNumber to CodecCode (c3af948)
  • Renaming of top-level exported functions for consistency: (b764341)
    - getCodec is now getNameFromData
    - getName is now getNameFromCode
    - getNumber is now getCodeFromName
    - getCode is now getCodeFromData
    - getCodeVarint is now getVarintFromName
    - getVarint is now getVarintFromCode-getVarintFromCodereturnsUint8Arrayinstead ofArray- **Backwards compatibility**: all old names were kept as alias andgetVariantreturns a regularArray`. They are deprecated methods and will be removed in a future major release.

BREAKING CHANGES

  • remove print top-level export, use getNameFromCode instead.

/cc @vmx @vasco-santos since my time is very limited (working at 25%), could any of you check if the current master code doesn't break js-ipfs? Thank you!

@BigLep
Copy link

BigLep commented May 3, 2021

Closing given we have 3.0.1: https://github.com/multiformats/js-multicodec/releases/tag/v3.0.1

@BigLep BigLep closed this as completed May 3, 2021
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

No branches or pull requests

2 participants