igpapi — Instagram private API Simulator for Node.js (API reference) 4.14.0
    Preparing search index...

    Interface LaunchBurstMarks<LaunchInput, FE, FR, SE, SR>

    What a launch's burst is written with, handed to the declaration's burst by the entry on every launch:

    • firstScreen is the mark of the place in the burst where the first screen enters through the launch edge (enterRoot) and sends its own enter, which yields the screen's navigate. The burst runs it exactly once, at the position where the app writes it; never or twice is ScreenLaunchFirstScreenError.
    • splashScreen is the mark of the launch's splash over the first screen (a declaration without one fails with ScreenLaunchSplashNotDeclaredError); it runs at most once, and the entry returns the screen actually on top afterwards.
    • input is the caller's launch input.
    • launchCommitted resolves true once the launch's transition has committed (the first screen is on the stack and the launch's result is about to be handed back), and false when the launch failed, was rolled back or was interrupted. A burst that hands the rest of its order to the process's background fibers (MobileProcessBackground.handOver) starts that work behind this mark: outside the committed launch no transition of the tail may run, and a launch that rolled back sends no tail at all.
    interface LaunchBurstMarks<
        LaunchInput,
        FE,
        FR,
        SE = ScreenLaunchSplashNotDeclaredError,
        SR = never,
    > {
        firstScreen: Effect<void, FE, FR>;
        input: LaunchInput;
        launchCommitted: Effect<boolean>;
        splashScreen: Effect<void, SE, SR>;
    }

    Type Parameters

    Index

    Properties

    firstScreen: Effect<void, FE, FR>
    launchCommitted: Effect<boolean>
    splashScreen: Effect<void, SE, SR>