https://github.com/rars/ngx-jwt

Angular library for injecting JWT tokens to HTTP requests.
https://github.com/rars/ngx-jwt

Last synced: about 2 months ago
JSON representation

Angular library for injecting JWT tokens to HTTP requests.

• Host: GitHub
• URL: https://github.com/rars/ngx-jwt
• Owner: rars
• License: other
• Created: 2018-01-06T19:42:35.000Z (about 7 years ago)
• Default Branch: main
• Last Pushed: 2024-03-29T00:59:18.000Z (10 months ago)
• Last Synced: 2024-04-14T10:09:44.322Z (9 months ago)
• Language: TypeScript
• Homepage:
• Size: 3.54 MB
• Stars: 1
• Watchers: 2
• Forks: 0
• Open Issues: 2
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE.md

Awesome Lists containing this project

• awesome-angular - ngx-jwt - Angular library for injecting JWT tokens to HTTP requests. (Table of contents / Angular)
• fucking-awesome-angular - ngx-jwt - Angular library for injecting JWT tokens to HTTP requests. (Table of contents / Angular)
• fucking-awesome-angular - ngx-jwt - Angular library for injecting JWT tokens to HTTP requests. (Table of contents / Angular)

README

        
# ngx-jwt

[![Conventional Commits](https://img.shields.io/badge/Conventional%20Commits-1.0.0-yellow.svg)](https://conventionalcommits.org)

[![Node.js CI](https://github.com/rars/ngx-jwt/actions/workflows/node.js.yml/badge.svg)](https://github.com/rars/ngx-jwt/actions/workflows/node.js.yml)

Angular4+ module for adding JWT authorisation tokens to HTTP requests.

## Quickstart

1. Install `ngx-jwt` modules from npm:

   ```

   npm install ngx-jwt --save

   ```

2. Import `NgxJwtModule` to your app:

   ```

   import { BrowserModule } from '@angular/platform-browser';

   import { NgModule } from '@angular/core';

   import { of } from 'rxjs';

   import { NgxJwtModule, NgxJwtConfig } from 'ngx-jwt';

   import { AppComponent } from './app.component';

   export function createNgxJwtConfig(): NgxJwtConfig {

     return {

       tokenGetter: () => of('TOKEN'),

       blacklistedDomains: ['auth-service'],

       whitelistedDomains: [],

       throwNoTokenError: true,

       skipWhenExpired: false,

       headerName: 'Authorization',

       authScheme: 'Bearer'

     };

   }

   @NgModule({

     declarations: [

       AppComponent

     ],

     imports: [

       BrowserModule,

       NgxJwtModule.forRoot({

         provider: {

           provide: NgxJwtConfig,

           useFactory: createNgxJwtConfig

         }

       })

     ],

     providers: [],

     bootstrap: [AppComponent]

   })

   export class AppModule { }

   ```

## Compatibility

Recommended versions by Angular version:

| Angular | ngx-jwt |

| ------- | ------- |

| ^4.3.0  | ^0.2.0  |

| ^5.0.0  | ^0.2.0  |

| ^6.0.0  | ^0.3.0  |

| ^7.0.0  | ^0.3.0  |

| ^8.0.0  | ^0.4.0  |

| ^9.0.0  | ^0.5.0  |

| ^13.0.0 | ^1.0.0  |

| ^16.0.0 | ^2.0.0  |

| ^17.0.0 | ^3.0.0  |

| ^18.0.0 | ^4.0.0  |

## Contributions welcome!

If you have a feature or improvement you would like to see included, please raise an issue or a PR and I will review.

## License

See the [LICENSE](LICENSE.md) file for license rights and limitations (MIT).