GithubHelp home page GithubHelp logo

Comments (5)

palortoff avatar palortoff commented on July 27, 2024

I've started reimplementing against the new API. Might take a while...

There will be huge breaking changes.
Most property names have changed.

I think it would be best to support both APIs as long as the old one is up and running.

from node-tvdb.

edwellbrook avatar edwellbrook commented on July 27, 2024

Heya, thanks for starting on this work. Please feel free to submit pull requests to the new-tvdb-api branch so others can help as well. I believe @yvanavermaet is also working on updating for the new API.

Breaking changes and updated property names are fine IMO if we:

  • release the package strictly targeting a version of the new API
  • always return an expected format for each call which is documented in the README/docs
  • bump to a new major version when we publish to npm

Happy to support both APIs simultaneously while the new client is in development, but once we're happy with it I'd like to only support the new client. People wanting to use the old client can target an older version of the package on npm, and transition to the new client at their own pace.

Let me know what you think 😃

from node-tvdb.

palortoff avatar palortoff commented on July 27, 2024

OK, API 2.0 only it is.
Definitely makes things easier :-)
I don't think we need to keep the old API during development. It will be on another branch until release anyway...

I did not start using the new-tvdb-api branch, as it is over a year old. I branched from master and started from scratch.
I'll probably have something worth pushing tonight. If you create a new branch from the current master I'll make a pull request to it.

Do you think we can retire the callback API? Supporting only the promise API is sufficient in my opinion.

from node-tvdb.

edwellbrook avatar edwellbrook commented on July 27, 2024

Sorry yes, I meant support them simultaneously in separate branches. One branch only targets old API (master) and one targets new API (new-tvdb-api).

Happy for you to have branched off of master, but could we still have pull requests (even if there are merge conflicts) directed at the new-tvdb-api branch. I'm also more than happy to overwrite the existing branch with your work and help get it into the repo. Looking forward to your PR so myself and others can work alongside you!

Keen to remove either callback or promises, as I think having both is perhaps a little overkill. If your pull request only offers promises that's fine; if you want to support both for the time being, and submit a PR for the removal of the callback API that's fine as well — your choice. :)

from node-tvdb.

edwellbrook avatar edwellbrook commented on July 27, 2024

@palortoff Thanks again, so much for your help on getting this out. Sorry for how long it's taken 😅

from node-tvdb.

Related Issues (20)

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. 📊📈🎉

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google ❤️ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.