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

Refactor 0x.js exported interface #963

Closed
wants to merge 6 commits into from

Conversation

fabioberger
Copy link
Contributor

@fabioberger fabioberger commented Aug 14, 2018

Description

Until now, we've been maintaining a legacy public interface for 0x.js. Now that we've broken up the package into several smaller packages that can be imported separately:

  • @0xproject/contract-wrappers
  • @0xproject/order-utils
  • @0xproject/order-watcher

It makes sense to remove the legacy interface and instead, re-export the same exports from these individual packages as the exports available via 0x.js.

Benefits

  • This will make it trivial for someone to migrate from 0x.js to only importing the sub-packages they actually use.
  • It should still be a useable and intuitive interface since it's good enough for the sub-packages.
  • We don't need to maintain the duplicitous code in 0x.ts, nor any tests for them.

Testing instructions

Types of changes

Checklist:

  • Prefix PR title with [WIP] if necessary.
  • Prefix PR title with bracketed package name(s) corresponding to the changed package(s). For example: [sol-cov] Fixed bug.
  • Add tests to cover changes as needed.
  • Update documentation as needed.
  • Add new entries to the relevant CHANGELOG.jsons.

@fabioberger fabioberger requested a review from albrow August 14, 2018 01:53
@fabioberger fabioberger changed the title [WIP] Refactor 0x.js exported interface Refactor 0x.js exported interface Aug 14, 2018
@coveralls
Copy link

Coverage Status

Coverage decreased (-0.2%) to 84.157% when pulling f2d9dfb on refactor/0x-js-exported-interface into fadd292 on development.

Copy link
Contributor

@albrow albrow left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

🎉 after CI passes and merge conflicts are fixed.

@fabioberger
Copy link
Contributor Author

Will make this part of my other PR since I used the missing/superfluous export detection feature in there to perfect the index.ts file.

@fabioberger fabioberger deleted the refactor/0x-js-exported-interface branch March 13, 2019 21:07
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants