Narnia's Poofy Meatcleaver

    integreat-authenticator-jwt
    TypeScript icon, indicating that this package has built-in type declarations

    0.3.3 • Public • Published

    JWT authenticator for Integreat

    Signs a JWT token.

    npm Version Build Status Coverage Status Dependencies Status Maintainability

    Getting started

    Prerequisits

    Requires node v14 and Integreat v0.8.

    Installing and using

    Install from npm:

    npm install integreat-authenticator-jwt
    

    The authenticator supports the following options:

    • key: The key to sign the JWT with. Required
    • algorithm: The algorithm to sign with. Default HS256
    • subPath: A dot notation path into the request object, to get the JWT sub claim
    • audience: The JWT audience claim. Required
    • expiresIn: The expiration time for the JWT, as a ms string. When not set, the token will never expire
    • payload: An object whose properties will be set on the JWT payload

    Running the tests

    The tests can be run with npm test.

    Contributing

    Please read CONTRIBUTING for details on our code of conduct, and the process for submitting pull requests.

    License

    This project is licensed under the ISC License - see the LICENSE file for details.

    Keywords

    none

    Install

    npm i integreat-authenticator-jwt

    DownloadsWeekly Downloads

    7

    Version

    0.3.3

    License

    ISC

    Unpacked Size

    14.2 kB

    Total Files

    7

    Last publish

    Collaborators

    • kjellmorten