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

Improve documentation for decoding a single key vs multiple keys #461

Open
CJ42 opened this issue Jun 25, 2024 · 0 comments
Open

Improve documentation for decoding a single key vs multiple keys #461

CJ42 opened this issue Jun 25, 2024 · 0 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@CJ42
Copy link
Collaborator

CJ42 commented Jun 25, 2024

Summary

The documentation does not make it clear that it is possible to use ERC725.decodeData(...) to decode both:

  • a single data key, passing an object as parameter.
  • multiple data keys, passing an array of objects as parameter.

See examples below

This can be useful to know, as encodeData only works with objects right now, so array destructuring can be cumbersome at times.

https://github.com/ERC725Alliance/erc725.js/blob/develop/docs/methods.md#single-key-example

image
@CJ42 CJ42 added the documentation Improvements or additions to documentation label Jun 25, 2024
@CJ42 CJ42 added the good first issue Good for newcomers label Nov 6, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

1 participant