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

feat: updating API to be more javascript-friendly #2

Merged
merged 1 commit into from
Jan 1, 2024
Merged

Conversation

chanind
Copy link
Owner

@chanind chanind commented Jan 1, 2024

This PR updates the public API of the library to better fit with javascript standards, as Javascript and Python have different features and thus directly translating the Python to Javascript often leads to awkward methods and modules.

BREAKING CHANGE: This PR removes all submodules, and instead exports everything only from the main index.ts entry point
BREAKING CHANGE: This PR replaces any functions that have multiple optional parameters with an optional options object instead, to avoid needing to pass undefined for unused function arguments
BREAKING CHANGE: This PR renames all constant module functions and exports by adding the word Constant to their names

@chanind chanind merged commit cc75de2 into main Jan 1, 2024
2 checks passed
@chanind chanind deleted the jsified-api branch January 1, 2024 05:59
github-actions bot pushed a commit that referenced this pull request Jan 1, 2024
# [2.0.0](v1.0.2...v2.0.0) (2024-01-01)

* making API more javascripty (#2) ([cc75de2](cc75de2)), closes [#2](#2)

### BREAKING CHANGES

* This PR removes all submodules, and instead exports everything only from the main index.ts entry point
* This PR replaces any functions that have multiple optional parameters with an optional options object instead, to avoid needing to pass undefined for unused function arguments
* This PR renames all constant module functions and exports by adding the word Constant to their names
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

1 participant