Code Monkey home page Code Monkey logo

Comments (4)

scttcper avatar scttcper commented on August 21, 2024 1

The docs say a promise is returned. This is why I was surprised to find bluebird was brought in to wrap a single function. I don't see an issue bumping the major version to be safe. Really wish koa would go full on v2

from jwt.

sdd avatar sdd commented on August 21, 2024

My last comment on #58:

After thinking about it a bit more and looking into it, the SemVer spec itself states as point 1:

Software using Semantic Versioning MUST declare a public API. This API could be declared in the code itself or exist strictly in documentation. However it is done, it should be precise and comprehensive.

Since our documentation and koa's documentation on the usage of middleware are as close as we come to having an explicit public API, we either consider that to be our public API or we aren't SemVer.

With this in mind, usage of koa-jwt that extends the library and depends upon using bluebird-only promise methods rather than using it as documented could be considered to not be using the public API. As such, we would not require a major version bump.

Thoughts?

from jwt.

nfantone avatar nfantone commented on August 21, 2024

I (kinda) agree on the "misusage" of the API argument. It's a case of "penalizing" not-so-good users. Personally, I wouldn't mind a minor bump for this. But since we cannot safe-guard against all breaking changes, I'd also include some comment on the docs, somewhere. Maybe on the README.md.

from jwt.

cncolder avatar cncolder commented on August 21, 2024

[email protected] has released! It's time to face this issue. I think sindresorhus/pify is a good choice. It use native Promise default.

from jwt.

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.