Skip to content
This repository has been archived by the owner on Sep 3, 2021. It is now read-only.

Deprecate .codec property with a warning #119

Open
Gozala opened this issue Aug 7, 2020 · 2 comments
Open

Deprecate .codec property with a warning #119

Gozala opened this issue Aug 7, 2020 · 2 comments
Labels
status/ready Ready to be worked

Comments

@Gozala
Copy link
Contributor

Gozala commented Aug 7, 2020

We should emit a warning first time .codec property is accessed, that provides link to the instructions for migration from .codec to .code. Current plan is to have it indefinitely, that is until we ipfs ecosystem migrates to js-multiformats.

The reason we want warnings is because users usually get CID e.g. by calling const { cid } = await ipfs.add(...), so this could provide room for migration instead of clean break.

@Gozala
Copy link
Contributor Author

Gozala commented Aug 7, 2020

@mikeal do you mind creating a markdown file in the repo that warning could point at. I think you have much clear understanding of this than anyone else.

@mikeal
Copy link
Contributor

mikeal commented Aug 7, 2020

We have this https://github.com/multiformats/js-multiformats#cid, we can extend it to handle this with an example like we talked about or do you feel strongly about having a markdown file in this repo?

@Gozala Gozala added the status/ready Ready to be worked label Aug 20, 2020
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
status/ready Ready to be worked
Projects
None yet
Development

No branches or pull requests

2 participants