Custom Storage

The library uses the sessionStorage as the default storage mechanism. If needed, you can create a custom storage implementation, e.g. to use localStorage or cookies. A storage provider is implemented as a class with the AbstractSecurityStorage interface and the read, write and remove methods. The following example shows a custom storage that uses localStorage:

import { AbstractSecurityStorage } from 'angular-auth-oidc-client';

@Injectable()
export class MyStorageService implements AbstractSecurityStorage {
  read(key: string): string | null {
    return localStorage.getItem(key);
  }

  write(key: string, value: string): void {
    localStorage.setItem(key, value);
  }

  remove(key: string): void {
    localStorage.removeItem(key);
  }

  clear(): void {
    localStorage.clear();
  }
}

Then provide the custom storage class in the ApplicationConfig:

export const appConfig: ApplicationConfig = {
  providers: [
    provideAuth({
      // ..
    }),
    { provide: AbstractSecurityStorage, useClass: MyStorageService },
  ],
};

NgModule

You can also provide the storage class in a module using the providers array:

@NgModule({
  imports: [
    AuthModule.forRoot({
      config: {
        // ...
      },
    }),
  ],
  providers: [{ provide: AbstractSecurityStorage, useClass: MyStorageService }],
  exports: [AuthModule],
})
export class AuthConfigModule {}