AngularTS
    Preparing search index...

    Type Alias StateService<TRouteMap>

    type StateService<TRouteMap extends RouteMap = Record<string, never>> = {
        current: StateDeclaration | undefined;
        params: RawParams;
        getState(
            stateOrName: StateOrName,
            base?: StateOrName,
        ): StateDeclaration | undefined;
        getStates(): StateDeclaration[];
        go<TRouteName extends string>(
            to: TRouteName,
            ...args: RouteParamArgs<TRouteMap, TRouteName, TransitionOptions>,
        ): TransitionPromise;
        go(
            to: TRouteMap extends Record<string, never>
                ? StateOrName
                : StateDeclaration | StateObject,
            params?: RawParams,
            options?: TransitionOptions,
        ): TransitionPromise;
        href<TRouteName extends string>(
            stateOrName: TRouteName,
            ...args: RouteParamArgs<TRouteMap, TRouteName, HrefOptions>,
        ): string | null;
        href(
            stateOrName: TRouteMap extends Record<string, never>
                ? StateOrName
                : StateDeclaration | StateObject,
            params?: RawParams,
            options?: HrefOptions,
        ): string | null;
        matches(
            stateOrName: StateOrName,
            params?: RawParams,
            options?: { exact?: boolean; relative?: StateOrName },
        ): boolean;
        prefetch<TRouteName extends string>(
            stateOrName: TRouteName,
            ...args: RouteParamArgs<TRouteMap, TRouteName, TransitionOptions>,
        ): Promise<void>;
        prefetch(
            stateOrName: TRouteMap extends Record<string, never>
                ? StateOrName
                : StateDeclaration | StateObject,
            params?: RawParams,
            options?: TransitionOptions,
        ): Promise<void>;
        target(
            identifier: StateOrName,
            params?: RawParams,
            options?: TransitionOptions,
        ): TargetState;
    }

    Type Parameters

    • TRouteMap extends RouteMap = Record<string, never>
    Index

    Properties

    current params

    Methods

    getState getStates go href matches prefetch target

    Properties
    current: StateDeclaration | undefined

    The current state declaration, when navigation has selected one.

    params: RawParams

    The latest successful state parameters.

    Methods

    • Check whether the current state matches a state, ancestor, or glob.

      Parameters

      Returns boolean

    Settings
    Member Visibility

    On This Page
    Properties
    Methods