Backstage
    Preparing search index...

    Interface AppLifecycleApi

    Provides information about the lifecycle of the app.

    The app is rendered before it has been fully initialized, for example while the user is signing in. During this time only part of the app is available, which for example means that routes to pages can not yet be resolved. Once initialization completes the app is considered finalized.

    interface AppLifecycleApi {
        isFinalized(): boolean;
        subscribe(listener: () => void): () => void;
    }
    Index
    isFinalized subscribe

    • Subscribes to changes in the lifecycle of the app.

      Parameters

      • listener: () => void

      Returns () => void

      A function that removes the subscription.

      The listener is called without arguments whenever the lifecycle changes. Use the other methods of this API to read the current state.

    Settings
    Member Visibility

    On This Page
    Methods