-
-
Notifications
You must be signed in to change notification settings - Fork 48
feat(v2.0.0): BREAKING CHANGES: updated all FNs to use object parameters, removed deprecated functions, updated tests #90
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
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
tiagosiebler
requested changes
Mar 27, 2025
tiagosiebler
approved these changes
Mar 27, 2025
| // expect(e).toBeFalsy(); | ||
| expect(e).toMatchObject( | ||
| errorResponseObject( | ||
| '51010', |
Owner
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Could also start doing the api error code enum, but not in this PR. In future...
This was referenced Mar 27, 2025
Closed
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
feat(): removed all deprecated functions, updated all FNs to use object parameters
Breaking Changes:
This PR finalises breaking changes planned a while back (see #88). Any REST API functions that had request properties as individual function parameters, will now only accept an object with the expected request parameters.
While we try to avoid breaking changes where possible, this is one that we saw as necessary to improve maintainability. Especially as new parameters are added to existing endpoints, introducing complexity in handling multiple separate parameters if some were optional.
The easiest way to address these changes it to look for any API calls where parameters are passed individually, for example:
Update the parameters to pass as an object instead:
If you're not sure about the property names in the request object, refer to the OKX API documentation or the REST client. A convenient clickable list of endpoints can be found here:
https://github.com/tiagosiebler/okx-api/blob/master/docs/endpointFunctionList.md#how-to-use-table
If you're not already using it, typescript is highly recommended since it will catch any mistakes before you run your code.