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

Change names of SwimJS WarpClient syncing and linking APIs to their v3 names #157

Open
cwjames19 opened this issue Mar 4, 2024 · 0 comments
Assignees

Comments

@cwjames19
Copy link
Contributor

Is your feature request related to a problem? Please describe.
Changes to the naming of some WarpClient APIs have made them out of sync with the naming of the same APIs in SwimJava packages. The APIs in question are WarpClient.syncs, (used to be "keepSynced"), WarpClient.relinks (used to be "keepLinked"), WarpClient.sync() (sounds like a declarative action but is actually a getter/setter for the syncs property), WarpClient.link() (sounds like a declarative action but is actually a getter/setter for the relinks property)

Describe the solution you'd like
Change the names of the APIs back to what they were before so they may be consistent across platforms.

Describe alternatives you've considered
We could keep the current naming, which is different from SwimJava's, but I don't see a benefit for it. The contributor who takes on this issue should try and figure out what they original reason for renaming the APIs was.

Additional context
A PR for this issue must be accompanied by a matching PR with corresponding updates to Swim Docs.

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

No branches or pull requests

1 participant