@rxap/authentication
Version:
Provides authentication services, guards, and interceptors for Angular applications. It supports token-based authentication and provides features such as sign-out functionality and routing based on authentication status. This package also includes utiliti
82 lines (41 loc) • 2.74 kB
Markdown
[**@rxap/authentication v19.0.4**](../README.md)
***
[@rxap/authentication](../globals.md) / RxapAuthenticationService
# Class: RxapAuthenticationService
Defined in: [authentication.service.ts:31](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L31)
## Implements
- [`IAuthenticationService`](../interfaces/IAuthenticationService.md)
## Constructors
### new RxapAuthenticationService()
> **new RxapAuthenticationService**(): [`RxapAuthenticationService`](RxapAuthenticationService.md)
Defined in: [authentication.service.ts:39](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L39)
#### Returns
[`RxapAuthenticationService`](RxapAuthenticationService.md)
## Properties
### events$
> `readonly` **events$**: `ReplaySubject`\<[`AuthenticationEvent`](../interfaces/AuthenticationEvent.md)\>
Defined in: [authentication.service.ts:35](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L35)
#### Implementation of
[`IAuthenticationService`](../interfaces/IAuthenticationService.md).[`events$`](../interfaces/IAuthenticationService.md#events$)
***
### isAuthenticated$
> **isAuthenticated$**: `BehaviorSubject`\<`null` \| `boolean`\>
Defined in: [authentication.service.ts:33](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L33)
#### Implementation of
[`IAuthenticationService`](../interfaces/IAuthenticationService.md).[`isAuthenticated$`](../interfaces/IAuthenticationService.md#isauthenticated$)
## Methods
### isAuthenticated()
> **isAuthenticated**(): `Promise`\<`boolean`\>
Defined in: [authentication.service.ts:49](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L49)
#### Returns
`Promise`\<`boolean`\>
#### Implementation of
[`IAuthenticationService`](../interfaces/IAuthenticationService.md).[`isAuthenticated`](../interfaces/IAuthenticationService.md#isauthenticated)
***
### signOut()
> **signOut**(): `Promise`\<`void`\>
Defined in: [authentication.service.ts:43](https://gitlab.com/rxap/packages/-/blob/3eebed1be2bbb37bc0d65959f8fecbb850c0b8aa/packages/angular/authentication/src/lib/authentication.service.ts#L43)
#### Returns
`Promise`\<`void`\>
#### Implementation of
[`IAuthenticationService`](../interfaces/IAuthenticationService.md).[`signOut`](../interfaces/IAuthenticationService.md#signout)