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

    Interface ScreenFeedMembers<Cursor, Page, FE, FR>

    The member a feed screen's handle gets — the feed's raw pagination, which every feed has, swipeable or not: nextPage, which returns a new instance of the feed showing the page after the one it is asked of — one page request, exactly as the app sends it — and never changes the instance it is asked of; undefined, with nothing sent, when the answer said no page follows. The instance is typed as the handle it is called on.

    interface ScreenFeedMembers<Cursor, Page, FE, FR> {
        nextPage: ScreenScrollMember<
            ScreenScrollShape<Page, ScreenFeedPageFailure<FE, Page>, "host">,
            (
                self: ScreenHandle,
                state: { cursor: Cursor | undefined },
            ) => () => Effect<
                ScreenHandle
                | undefined,
                ScreenFeedPageFailure<FE, Page>,
                ScreenFeedPageServices<FR, Page>,
            >,
        >;
        stream: ScreenItemFieldMember<
            ScreenItemFieldShape<Page, "stream", ScreenFeedPageFailure<FE, Page>>,
            (
                self: ScreenHandle,
                state: { cursor: Cursor | undefined },
            ) => Stream<
                ScreenHandle,
                ScreenFeedPageFailure<FE, Page>,
                ScreenFeedPageServices<FR, Page>,
            >,
        >;
    }

    Type Parameters

    • Cursor
    • Page
    • FE
    • FR
    Index

    Properties

    Properties

    nextPage: ScreenScrollMember<
        ScreenScrollShape<Page, ScreenFeedPageFailure<FE, Page>, "host">,
        (
            self: ScreenHandle,
            state: { cursor: Cursor | undefined },
        ) => () => Effect<
            ScreenHandle
            | undefined,
            ScreenFeedPageFailure<FE, Page>,
            ScreenFeedPageServices<FR, Page>,
        >,
    >
    stream: ScreenItemFieldMember<
        ScreenItemFieldShape<Page, "stream", ScreenFeedPageFailure<FE, Page>>,
        (
            self: ScreenHandle,
            state: { cursor: Cursor | undefined },
        ) => Stream<
            ScreenHandle,
            ScreenFeedPageFailure<FE, Page>,
            ScreenFeedPageServices<FR, Page>,
        >,
    >

    The feed's items, one by one, as a lazy stream. A plain feed's stream gets them by page requests from this instance's page on: each pull past a page's last item is that page's nextPage — one page request, as the app sends it — to the feed's end. A swipeable feed overrides it (ScreenSwipeMembers): its stream is walked by swipes, as the app does. Nothing runs until it is consumed; stopping, take or a failure requests no page beyond the one the last pulled item came from.