search

swimos / swim

Full stack application platform for building stateful microservices, streaming APIs, and real-time UIs
https://www.swimos.org
Apache License 2.0
488 stars 41 forks source link

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

Open cwjames19 opened 7 months ago

cwjames19 commented 7 months ago

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.