Important: This documentation covers Yarn 1 (Classic).
For Yarn 2+ docs and migration guide, see yarnpkg.com.

Package detail

@everllence/ngx-chain-functional-guards

everllence561MIT19.0.2TypeScript support: included

An Angular guard that executes functional guards in a serial manner, waiting for each one to complete before proceeding to the next.

angular, guard, chain, serially

readme

<picture> <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/everllence/ngx-tools/master/images/everllence-ngx-tools-dark.svg"> Everllence NGX · Tools </picture>

License npm version Semantic Release


Ngx Chain Functional Guards

Ngx Chain Functional Guards is a small library that exposes two functions chainActivationGuards and chainDeactivationGuards. Both of these functions allow to run guards in a serial manner, waiting for each one to complete before proceeding to the next.

Installation

Requires the following peer dependencies:

  • @angular/core (>= 18.0.0)
  • @angular/router (>= 18.0.0)
  • rxjs (>= 7.0.0)

Example

canActivate, canActivateChild

import { chainActivationGuards } from 'ngx-chain-functional-guards';

// In the route config:
{
  path: '...',
  // chain the desired guards
  canActivate: [chainActivationGuards([SomeGuard1, SomeGuard2, ...])],
  ...
}

canDeactivate

import { chainDeactivationGuards } from 'ngx-chain-guards';

// In the route config:
{
  path: '...',
  // chain the desired guards
  canDeactivate: [chainDeactivationGuards([SomeGuard1, SomeGuard2, ...])],
}

API

CanActivateChildFn, CanActivateFn

The chainActivationGuards function lets you add an array of guards to be executed in a serial manner.

export declare function chainActivationGuards(guards: CanActivateFn[] | CanActivateChildFn[]): CanActivateFn | CanActivateChildFn

CanDeactivateFn

The chainDeactivationGuards function lets you add an array of guards to be executed in a serial manner.

export declare function chainDeactivationGuards(guards: CanDeactivateFn<never>[]): CanDeactivateFn<never>

Utilities

wrapIntoObservable

A lightweight utility function that normalizes any value—whether it's a plain value, a Promise, or an Observable—into an Observable. This is especially useful in Angular or RxJS-heavy applications where consistent reactive patterns are desired.

export declare function wrapIntoObservable<T>(value: T | Promise<T> | Observable<T>): Observable<T> {