@ngworker/router-component-store/lib/router-store.d.ts

A strictly typed lightweight alternative to NgRx Router Store (@ngrx/router-store) and ActivatedRoute

import { Type } from '@angular/core';
import { Event as RouterEvent } from '@angular/router';
import { Observable } from 'rxjs';
import { MinimalActivatedRouteSnapshot } from './@ngrx/router-store/minimal-activated-route-state-snapshot';
import { StrictQueryParams } from './strict-query-params';
import { StrictRouteData } from './strict-route-data';
import { StrictRouteParams } from './strict-route-params';
import * as i0 from "@angular/core";
/**
 * An Angular Router-connecting NgRx component store.
 *
 * A `RouterStore` service is provided by using either
 * `provideGlobalRouterStore` or `provideLocalRouterStore`.
 *
 * The _global_ `RouterStore` service is provided in a root environment injector
 * and is never destroyed but can be injected in any class.
 *
 * A _local_ `RouterStore` requires a component-level provider, follows the
 * lifecycle of that component, and can be injected in declarables as well as
 * other component-level services.
 *
 * @example
 * // Usage in a component
 * // hero-detail.component.ts
 * // (...)
 * import { RouterStore } from '@ngworker/router-component-store';
 *
 * (@)Component({
 *   // (...)
 * })
 * export class HeroDetailComponent {
 *   #routerStore = inject(RouterStore);
 *
 *   heroId$: Observable<string | undefined> = this.#routerStore.selectRouteParam('id');
 * }
 */
export declare abstract class RouterStore {
    /**
     * Select the current route.
     */
    abstract readonly currentRoute$: Observable<MinimalActivatedRouteSnapshot>;
    /**
     * Select the current route fragment.
     */
    abstract readonly fragment$: Observable<string | null>;
    /**
     * Select the current route query parameters.
     */
    abstract readonly queryParams$: Observable<StrictQueryParams>;
    /**
     * Select the current route data.
     */
    abstract readonly routeData$: Observable<StrictRouteData>;
    /**
     * Select the current route parameters.
     */
    abstract readonly routeParams$: Observable<StrictRouteParams>;
    /**
     * Select the resolved route title.
     */
    abstract readonly title$: Observable<string | undefined>;
    /**
     * Select the current URL.
     */
    abstract readonly url$: Observable<string>;
    /**
     * Select the specified route data.
     *
     * @deprecated Use {@link selectRouteDataParam} instead. To be removed in version 18.
     *
     * @param key The route data key.
     *
     * @example <caption>Usage</caption>
     * const limit$ = routerStore.selectRouteData('limit').pipe(map(x => Number(x)));
     */
    abstract selectRouteData(key: string): Observable<unknown>;
    /**
     * Select the specified route data.
     *
     * @param key The route data key.
     *
     * @example <caption>Usage</caption>
     * const limit$ = routerStore.selectRouteDataParam('limit').pipe(map(x => Number(x)));
     */
    abstract selectRouteDataParam(key: string): Observable<unknown>;
    /**
     * Select the specified query parameter.
     *
     * @param param The name of the query parameter.
     *
     * @example <caption>Usage</caption>
     * const order$ = routerStore.selectQueryParam('order');
     */
    abstract selectQueryParam(param: string): Observable<string | readonly string[] | undefined>;
    /**
     * Select the specified route parameter.
     *
     * @param param The name of the route parameter.
     *
     * @example <caption>Usage</caption>
     * const id$ = routerStore.selectRouteParam('id');
     */
    abstract selectRouteParam(param: string): Observable<string | undefined>;
    /**
     * Select router events of the specified router event types.
     *
     * @param acceptedEventTypes The types of router events to select.
     *
     * @example <caption>Usage</caption>
     * const navigation$ = routerStore.selectRouterEvents(NavigationStart, NavigationEnd);
     */
    abstract selectRouterEvents<TAcceptedRouterEvents extends Type<RouterEvent>[]>(...acceptedEventTypes: [...TAcceptedRouterEvents]): Observable<InstanceType<TAcceptedRouterEvents[number]>>;
    static ɵfac: i0.ɵɵFactoryDeclaration<RouterStore, never>;
    static ɵprov: i0.ɵɵInjectableDeclaration<RouterStore>;
}