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

    Interface ScreenEnter<Input>

    What a screen's enter receives: the edge's input, navigate, the screen's own navigation event — NavigateTo for a screen, SwitchTab for a tab, SwitchTopTab for an inner tab — with the source and ordinal skip of the edge that led here, and the visit it begins. The screen yields navigate exactly once, at the point of its burst where the app writes it (in 451 the first UserProfile requests still carry the SERP); a second yield dies with ScreenEnterNavigationError, and so does an enter that never yields it: the burst is the library's own definition, so a wrong count is a defect of the declaration, never a typed failure. The screen itself never sees the source.

    interface ScreenEnter<Input> {
        input: Input;
        navigate: Effect<void, never, MobileNavigation>;
        sendAcrossPush: <Args extends readonly unknown[], A, E, R>(
            answer: ScreenAnswerAcrossPush<Args, A, E, R>,
            ...args: Args,
        ) => Effect<void, never, MobileProcessBackground | R>;
        takeAcrossPush: <Args extends readonly unknown[], A, E, R>(
            answer: ScreenAnswerAcrossPush<Args, A, E, R>,
            ...args: Args,
        ) => Effect<A, E, R>;
        visit: ScreenEnterVisit;
    }

    Type Parameters

    • Input
    Index

    Properties

    input: Input
    navigate: Effect<void, never, MobileNavigation>
    sendAcrossPush: <Args extends readonly unknown[], A, E, R>(
        answer: ScreenAnswerAcrossPush<Args, A, E, R>,
        ...args: Args,
    ) => Effect<void, never, MobileProcessBackground | R>

    Sends answer's request now and goes on without waiting for it: the request stays in flight, and its answer is held for the screen this one pushes next, which takes it with takeAcrossPush instead of sending the request itself (answerAcrossPush). Call it at the point of the burst where the app sends the request.

    takeAcrossPush: <Args extends readonly unknown[], A, E, R>(
        answer: ScreenAnswerAcrossPush<Args, A, E, R>,
        ...args: Args,
    ) => Effect<A, E, R>

    The answer the screen below — the one whose edge pushed this screen — left in flight for answer with sendAcrossPush, awaited if it is still in flight; when it left none, answer's request sent here (answerAcrossPush).

    The visit this enter begins, without its chain: the burst itself moves the chain.