This repository has been archived by the owner on Aug 11, 2021. It is now read-only.
properties: align spec with implementations #46
Labels
api-review
Tackle during the API review
Comments
vmx
added a commit
that referenced
this issue
Nov 22, 2018
The whole IPLD APIs get a review to make them more consistent and easier to use. The biggest change is that there's not `resolve` API anymore. From now on you access the properties of the JavaScript objects directly. Issues that were taken into account: - #31 - [x] Remove `isLink()` method from formats: `isLink()` is no longer needed as all links will be CID objects you can easily check for - #44 - [x] Proposal: Move resolver to use CID instances for links: Not applicable anymore as `resolve.resolve()` is removed - #46 - [x] properties: align spec with implementation: Covered by spec - #49 - [x] Define how `toJSON()` should look like: Binary and CIDs are defined with example - #34 - [x] Implementation of nested objects: Won’t fix as `tree()` is not part of the API anymore
vmx
added a commit
that referenced
this issue
Nov 22, 2018
The whole IPLD APIs get a review to make them more consistent and easier to use. The biggest change is that there's not `resolve` API anymore. From now on you access the properties of the JavaScript objects directly. Issues that were taken into account: - #31 - [x] Remove `isLink()` method from formats: `isLink()` is no longer needed as all links will be CID objects you can easily check for - #44 - [x] Proposal: Move resolver to use CID instances for links: Not applicable anymore as `resolve.resolve()` is removed - #46 - [x] properties: align spec with implementation: Covered by spec - #49 - [x] Define how `toJSON()` should look like: Binary and CIDs are defined with example - #34 - [x] Implementation of nested objects: Won’t fix as `tree()` is not part of the API anymore Closes #48.
|
All IPLD Format implementations of this org currently conform to the current spec, |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
The spec says that
multicodecanddefaultHashAlgare top-level properties, but all implementations implement them as properties of the resolver.I'd argue that the implementations are wrong. The properties should really be top-level.
This issue should be tackled during the IPLD API review.
The text was updated successfully, but these errors were encountered: