Interface SearchInputHandle

The handle of SearchInputScreen: what you hold while the screen is open — its data, its actions (SearchInputActions) and its lists (SearchInputItems).

interface SearchInputHandle {
    back: ScreenBackEffect<
        AssembledHandle<
            "Explore",
            "tab",
            {
                recent: readonly {
                    fullName: string;
                    userId: string;
                    username: string;
                }[];
            },
            ExploreActions,
            Record<never, never>,
            ScreenHandle,
            "optional",
            false,
            never,
            unknown,
        >,
    >;
    change: <Self extends ScreenHandle>(
        this: Self,
        ...args: [query: string],
    ) => Effect<
        Self,
        ScreenDataActionFailure<
            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | SchemaError
            | GraphqlRootFieldMissingError,
        >,
        never,
    >;
    checkpoint: () => Effect<
        ScreenCheckpoint<"SearchInput">,
        ScreenCheckpointFailure,
    >;
    data: {
        query: string;
        rankToken: string;
        recentAccounts: readonly {
            fullName: string;
            userId: string;
            username: string;
        }[];
        results: readonly (
            | {
                __typename: "unknown";
                item: { kind: "unknown"; kindKey?: string; raw: Json };
                key: string;
            }
            | {
                __typename: "XDTTypeaheadSearchKeyword";
                key: string;
                keyword_lazified: {
                    id: string;
                    name: string;
                    user?: | {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    }
                    | null;
                };
            }
            | {
                __typename: "XDTTypeaheadSearchUser";
                key: string;
                rank_token?: string;
                user: {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                };
            }
            | {
                __typename: "XDTTypeaheadSearchHashtag";
                hashtag: { id: string; media_count?: number; name: string };
                key: string;
            }
            | {
                __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                key: string;
                keywords: readonly {
                    id: string;
                    name: string;
                    user?: | {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    }
                    | null;
                }[];
                num_keywords_to_show?: number;
                query_text: string;
            }
        )[];
        session?: {
            clientUuidRankToken: string;
            searchSessionId: string;
            serpSessionId?: string;
            typeaheadSessionId: string;
        };
    };
    id: "SearchInput";
    kind: "screen";
    origin: AssembledHandle<
        "Explore",
        "tab",
        {
            recent: readonly {
                fullName: string;
                userId: string;
                username: string;
            }[];
        },
        ExploreActions,
        Record<never, never>,
        ScreenHandle,
        "optional",
        false,
        never,
        unknown,
    >;
    pipe: {
        <A>(this: A): A;
        <A, B = never>(this: A, ab: (_: A) => B): B;
        <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C;
        <A, B = never, C = never, D = never>(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
        ): D;
        <A, B = never, C = never, D = never, E = never>(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
        ): E;
        <A, B = never, C = never, D = never, E = never, F = never>(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
        ): F;
        <A, B = never, C = never, D = never, E = never, F = never, G = never>(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
        ): G;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
        ): H;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
        ): I;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
        ): J;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
        ): K;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
        ): L;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
        ): M;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
        ): N;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
        ): O;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
        ): P;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
        ): Q;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
            R = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
            qr: (_: Q) => R,
        ): R;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
            R = never,
            S = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
            qr: (_: Q) => R,
            rs: (_: R) => S,
        ): S;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
            R = never,
            S = never,
            T = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
            qr: (_: Q) => R,
            rs: (_: R) => S,
            st: (_: S) => T,
        ): T;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
            R = never,
            S = never,
            T = never,
            U = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
            qr: (_: Q) => R,
            rs: (_: R) => S,
            st: (_: S) => T,
            tu: (_: T) => U,
        ): U;
        <
            A,
            B = never,
            C = never,
            D = never,
            E = never,
            F = never,
            G = never,
            H = never,
            I = never,
            J = never,
            K = never,
            L = never,
            M = never,
            N = never,
            O = never,
            P = never,
            Q = never,
            R = never,
            S = never,
            T = never,
            U = never,
        >(
            this: A,
            ab: (_: A) => B,
            bc: (_: B) => C,
            cd: (_: C) => D,
            de: (_: D) => E,
            ef: (_: E) => F,
            fg: (_: F) => G,
            gh: (_: G) => H,
            hi: (_: H) => I,
            ij: (_: I) => J,
            jk: (_: J) => K,
            kl: (_: K) => L,
            lm: (_: L) => M,
            mn: (_: M) => N,
            no: (_: N) => O,
            op: (_: O) => P,
            pq: (_: P) => Q,
            qr: (_: Q) => R,
            rs: (_: R) => S,
            st: (_: S) => T,
            tu: (_: T) => U,
        ): U;
    };
    raw: readonly RawAnswer[];
    recentAccounts: readonly ScreenListItem<
        {
            at: "recentAccounts";
            item: ScreenItemDefinition<
                "RecentSearchAccount",
                { fullName: string; userId: string; username: string },
                { fullName: string; userId: string; username: string },
                RecentSearchAccountState,
                never,
                never,
                RecentSearchAccountItemActions,
                undefined,
                never,
                never,
            >;
            key: "userId";
            source: ScreenNoItemNodes;
        },
        AssembledHandle<
            "SearchInput",
            "screen",
            {
                query: string;
                rankToken: string;
                recentAccounts: readonly {
                    fullName: string;
                    userId: string;
                    username: string;
                }[];
                results: readonly (
                    | {
                        __typename: "unknown";
                        item: { kind: "unknown"; kindKey?: string; raw: Json };
                        key: string;
                    }
                    | {
                        __typename: "XDTTypeaheadSearchKeyword";
                        key: string;
                        keyword_lazified: {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: (...)
                                | (...);
                                id: string;
                                is_private?: (...) | (...) | (...);
                                is_verified?: (...) | (...) | (...);
                                latest_reel_media?: (...) | (...) | (...);
                                profile_pic_url?: (...) | (...);
                                search_serp_type?: (...) | (...) | (...);
                                username: string;
                            }
                            | null;
                        };
                    }
                    | {
                        __typename: "XDTTypeaheadSearchUser";
                        key: string;
                        rank_token?: string;
                        user: {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        };
                    }
                    | {
                        __typename: "XDTTypeaheadSearchHashtag";
                        hashtag: { id: string; media_count?: number; name: string };
                        key: string;
                    }
                    | {
                        __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                        key: string;
                        keywords: readonly {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: ...;
                                id: ...;
                                is_private?: ...;
                                is_verified?: ...;
                                latest_reel_media?: ...;
                                profile_pic_url?: ...;
                                search_serp_type?: ...;
                                username: ...;
                            }
                            | null;
                        }[];
                        num_keywords_to_show?: number;
                        query_text: string;
                    }
                )[];
                session?: {
                    clientUuidRankToken: string;
                    searchSessionId: string;
                    serpSessionId?: string;
                    typeaheadSessionId: string;
                };
            },
            SearchInputActions,
            SearchInputItems,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,
    >[];
    results: readonly ScreenListItem<
        {
            at: "results";
            by: "__typename";
            key: "key";
            source: ScreenNoItemNodes;
            variants: {
                unknown: ScreenItemDefinition<
                    "SearchInputUnknownResult",
                    {
                        __typename: "unknown";
                        item: { kind: "unknown"; kindKey?: string; raw: Json };
                        key: string;
                    },
                    {
                        __typename: "unknown";
                        item: { kind: "unknown"; kindKey?: string; raw: Json };
                        key: string;
                    },
                    Record<never, never>,
                    never,
                    never,
                    TypeaheadUnknownResultItemActions,
                    undefined,
                    never,
                    never,
                >;
                XDTTypeaheadSearchHashtag: ScreenItemDefinition<
                    "SearchInputHashtagResult",
                    {
                        __typename: "XDTTypeaheadSearchHashtag";
                        hashtag: { id: string; media_count?: number; name: string };
                        key: string;
                    },
                    {
                        __typename: "XDTTypeaheadSearchHashtag";
                        hashtag: { id: string; media_count?: number; name: string };
                        key: string;
                    },
                    Record<never, never>,
                    never,
                    never,
                    TypeaheadHashtagResultItemActions,
                    undefined,
                    never,
                    never,
                >;
                XDTTypeaheadSearchKeyword: ScreenItemDefinition<
                    "SearchInputKeywordResult",
                    {
                        __typename: "XDTTypeaheadSearchKeyword";
                        key: string;
                        keyword_lazified: {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: string;
                                id: string;
                                is_private?: boolean;
                                is_verified?: boolean;
                                latest_reel_media?: number
                                | null;
                                profile_pic_url?: string;
                                search_serp_type?: number | null;
                                username: string;
                            }
                            | null;
                        };
                    },
                    {
                        __typename: "XDTTypeaheadSearchKeyword";
                        key: string;
                        keyword_lazified: {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: string;
                                id: string;
                                is_private?: boolean;
                                is_verified?: boolean;
                                latest_reel_media?: number
                                | null;
                                profile_pic_url?: string;
                                search_serp_type?: number | null;
                                username: string;
                            }
                            | null;
                        };
                    },
                    Record<never, never>,
                    never,
                    never,
                    TypeaheadKeywordResultItemActions,
                    undefined,
                    never,
                    never,
                >;
                XDTTypeaheadSearchOverfetchedKeywords: ScreenItemDefinition<
                    "SearchInputOverfetchedKeywordsResult",
                    {
                        __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                        key: string;
                        keywords: readonly {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: (...)
                                | (...);
                                id: string;
                                is_private?: (...) | (...) | (...);
                                is_verified?: (...) | (...) | (...);
                                latest_reel_media?: (...) | (...) | (...);
                                profile_pic_url?: (...) | (...);
                                search_serp_type?: (...) | (...) | (...);
                                username: string;
                            }
                            | null;
                        }[];
                        num_keywords_to_show?: number;
                        query_text: string;
                    },
                    {
                        __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                        key: string;
                        keywords: readonly {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: (...)
                                | (...);
                                id: string;
                                is_private?: (...) | (...) | (...);
                                is_verified?: (...) | (...) | (...);
                                latest_reel_media?: (...) | (...) | (...);
                                profile_pic_url?: (...) | (...);
                                search_serp_type?: (...) | (...) | (...);
                                username: string;
                            }
                            | null;
                        }[];
                        num_keywords_to_show?: number;
                        query_text: string;
                    },
                    Record<never, never>,
                    never,
                    never,
                    TypeaheadOverfetchedKeywordsResultItemActions,
                    undefined,
                    never,
                    never,
                >;
                XDTTypeaheadSearchUser: ScreenItemDefinition<
                    "SearchInputUserResult",
                    {
                        __typename: "XDTTypeaheadSearchUser";
                        key: string;
                        rank_token?: string;
                        user: {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        };
                    },
                    {
                        __typename: "XDTTypeaheadSearchUser";
                        key: string;
                        rank_token?: string;
                        user: {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        };
                    },
                    TypeaheadUserRowState,
                    never,
                    never,
                    TypeaheadUserResultItemActions,
                    undefined,
                    never,
                    never,
                >;
            };
        },
        AssembledHandle<
            "SearchInput",
            "screen",
            {
                query: string;
                rankToken: string;
                recentAccounts: readonly {
                    fullName: string;
                    userId: string;
                    username: string;
                }[];
                results: readonly (
                    | {
                        __typename: "unknown";
                        item: { kind: "unknown"; kindKey?: string; raw: Json };
                        key: string;
                    }
                    | {
                        __typename: "XDTTypeaheadSearchKeyword";
                        key: string;
                        keyword_lazified: {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: (...)
                                | (...);
                                id: string;
                                is_private?: (...) | (...) | (...);
                                is_verified?: (...) | (...) | (...);
                                latest_reel_media?: (...) | (...) | (...);
                                profile_pic_url?: (...) | (...);
                                search_serp_type?: (...) | (...) | (...);
                                username: string;
                            }
                            | null;
                        };
                    }
                    | {
                        __typename: "XDTTypeaheadSearchUser";
                        key: string;
                        rank_token?: string;
                        user: {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        };
                    }
                    | {
                        __typename: "XDTTypeaheadSearchHashtag";
                        hashtag: { id: string; media_count?: number; name: string };
                        key: string;
                    }
                    | {
                        __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                        key: string;
                        keywords: readonly {
                            id: string;
                            name: string;
                            user?: | {
                                full_name?: ...;
                                id: ...;
                                is_private?: ...;
                                is_verified?: ...;
                                latest_reel_media?: ...;
                                profile_pic_url?: ...;
                                search_serp_type?: ...;
                                username: ...;
                            }
                            | null;
                        }[];
                        num_keywords_to_show?: number;
                        query_text: string;
                    }
                )[];
                session?: {
                    clientUuidRankToken: string;
                    searchSessionId: string;
                    serpSessionId?: string;
                    typeaheadSessionId: string;
                };
            },
            SearchInputActions,
            SearchInputItems,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,
    >[];
    search: (
        ...args: readonly [string],
    ) => Effect<
        AssembledHandle<
            "SearchResultsTopTab",
            "screen",
            {
                query: string;
                session: {
                    clientUuidRankToken?: string;
                    searchSessionId: string;
                    serpSessionId: string;
                    typeaheadSessionId?: string;
                };
            },
            SearchResultsTopTabActions,
            Record<never, never>,
            ScreenHandle,
            "required",
            true,
            never,
            AndroidScreens,
        >,

            | IgApiError
            | RequestError
            | ParseError
            | TransportError
            | ScreenEnterConcurrentError
            | ScreenDataError
            | ScreenEdgeInputError,
        never,
    >;
    toJSON: () => {
        query: string;
        rankToken: string;
        recentAccounts: readonly {
            fullName: string;
            userId: string;
            username: string;
        }[];
        results: readonly (
            | {
                __typename: "unknown";
                item: { kind: "unknown"; kindKey?: string; raw: Json };
                key: string;
            }
            | {
                __typename: "XDTTypeaheadSearchKeyword";
                key: string;
                keyword_lazified: {
                    id: string;
                    name: string;
                    user?: | {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    }
                    | null;
                };
            }
            | {
                __typename: "XDTTypeaheadSearchUser";
                key: string;
                rank_token?: string;
                user: {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                };
            }
            | {
                __typename: "XDTTypeaheadSearchHashtag";
                hashtag: { id: string; media_count?: number; name: string };
                key: string;
            }
            | {
                __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                key: string;
                keywords: readonly {
                    id: string;
                    name: string;
                    user?: | {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    }
                    | null;
                }[];
                num_keywords_to_show?: number;
                query_text: string;
            }
        )[];
        session?: {
            clientUuidRankToken: string;
            searchSessionId: string;
            serpSessionId?: string;
            typeaheadSessionId: string;
        };
    };
}

Index

Properties

back change checkpoint data id kind origin pipe raw recentAccounts results search toJSON

Properties

`Readonly`back

back: ScreenBackEffect<
    AssembledHandle<
        "Explore",
        "tab",
        {
            recent: readonly {
                fullName: string;
                userId: string;
                username: string;
            }[];
        },
        ExploreActions,
        Record<never, never>,
        ScreenHandle,
        "optional",
        false,
        never,
        unknown,
    >,
>

Goes back, as the system back does: closes this screen and answers the screen below it, typed as the screens that can open this one.

`Readonly`change

Types in the search field (query): looks the text up. Answers the field shown again over the fresh data (the query, its results and the rank token); continue from it for the next keystroke, which carries on the same typing session. A text this typing session already answered shows that answer and sends nothing.

`Readonly`checkpoint

checkpoint: () => Effect<
ScreenCheckpoint<"SearchInput">,
ScreenCheckpointFailure,
>

Takes a checkpoint of the process with this screen on top: what a fresh process needs to continue from it (restoreCheckpoint), the stack below included, without opening any screen again.

`Readonly`data

data: {
    query: string;
    rankToken: string;
    recentAccounts: readonly {
        fullName: string;
        userId: string;
        username: string;
    }[];
    results: readonly (
        | {
            __typename: "unknown";
            item: { kind: "unknown"; kindKey?: string; raw: Json };
            key: string;
        }
        | {
            __typename: "XDTTypeaheadSearchKeyword";
            key: string;
            keyword_lazified: {
                id: string;
                name: string;
                user?: | {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                }
                | null;
            };
        }
        | {
            __typename: "XDTTypeaheadSearchUser";
            key: string;
            rank_token?: string;
            user: {
                full_name?: string;
                id: string;
                is_private?: boolean;
                is_verified?: boolean;
                latest_reel_media?: number
                | null;
                profile_pic_url?: string;
                search_serp_type?: number | null;
                username: string;
            };
        }
        | {
            __typename: "XDTTypeaheadSearchHashtag";
            hashtag: { id: string; media_count?: number; name: string };
            key: string;
        }
        | {
            __typename: "XDTTypeaheadSearchOverfetchedKeywords";
            key: string;
            keywords: readonly {
                id: string;
                name: string;
                user?: | {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                }
                | null;
            }[];
            num_keywords_to_show?: number;
            query_text: string;
        }
    )[];
    session?: {
        clientUuidRankToken: string;
        searchSessionId: string;
        serpSessionId?: string;
        typeaheadSessionId: string;
    };
}

What the screen shows: its data, as its data schema types it.

Type Declaration

Readonlyquery: string
ReadonlyrankToken: string
ReadonlyrecentAccounts: readonly { fullName: string; userId: string; username: string }[]
The recent accounts the field lists as items; empty for a typed open and after a keystroke, which replaces them with the suggestions.
Readonlyresults: readonly (
    | {
        __typename: "unknown";
        item: { kind: "unknown"; kindKey?: string; raw: Json };
        key: string;
    }
    | {
        __typename: "XDTTypeaheadSearchKeyword";
        key: string;
        keyword_lazified: {
            id: string;
            name: string;
            user?: | {
                full_name?: string;
                id: string;
                is_private?: boolean;
                is_verified?: boolean;
                latest_reel_media?: number
                | null;
                profile_pic_url?: string;
                search_serp_type?: number | null;
                username: string;
            }
            | null;
        };
    }
    | {
        __typename: "XDTTypeaheadSearchUser";
        key: string;
        rank_token?: string;
        user: {
            full_name?: string;
            id: string;
            is_private?: boolean;
            is_verified?: boolean;
            latest_reel_media?: number
            | null;
            profile_pic_url?: string;
            search_serp_type?: number | null;
            username: string;
        };
    }
    | {
        __typename: "XDTTypeaheadSearchHashtag";
        hashtag: { id: string; media_count?: number; name: string };
        key: string;
    }
    | {
        __typename: "XDTTypeaheadSearchOverfetchedKeywords";
        key: string;
        keywords: readonly {
            id: string;
            name: string;
            user?: | {
                full_name?: string;
                id: string;
                is_private?: boolean;
                is_verified?: boolean;
                latest_reel_media?: number
                | null;
                profile_pic_url?: string;
                search_serp_type?: number | null;
                username: string;
            }
            | null;
        }[];
        num_keywords_to_show?: number;
        query_text: string;
    }
)[]
Optional Readonlysession?: {
    clientUuidRankToken: string;
    searchSessionId: string;
    serpSessionId?: string;
    typeaheadSessionId: string;
}
The search session a typed open started; absent on an empty open, which starts none.

`Readonly`id

id: "SearchInput"

Which screen this is: its id in the screen catalog (an item's: its item id).

`Readonly`kind

kind: "screen"

What kind of thing the screen is: a screen, a tab, an inner tab, a feed or an item.

`Readonly`origin

origin: AssembledHandle<
    "Explore",
    "tab",
    {
        recent: readonly { fullName: string; userId: string; username: string }[];
    },
    ExploreActions,
    Record<never, never>,
    ScreenHandle,
    "optional",
    false,
    never,
    unknown,
>

The handle this one was opened from: the screen (or the item of its list) whose call opened it, typed as what can open this screen; undefined for a launch's or a tab's root.

`Readonly`pipe

pipe: {
    <A>(this: A): A;
    <A, B = never>(this: A, ab: (_: A) => B): B;
    <A, B = never, C = never>(this: A, ab: (_: A) => B, bc: (_: B) => C): C;
    <A, B = never, C = never, D = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
    ): D;
    <A, B = never, C = never, D = never, E = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
    ): E;
    <A, B = never, C = never, D = never, E = never, F = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
    ): F;
    <A, B = never, C = never, D = never, E = never, F = never, G = never>(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
    ): G;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
    ): H;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
    ): I;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
    ): J;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
    ): K;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
    ): L;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
    ): M;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
    ): N;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
    ): O;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
    ): P;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
    ): Q;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
    ): R;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
    ): S;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
    ): T;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
        U = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
        tu: (_: T) => U,
    ): U;
    <
        A,
        B = never,
        C = never,
        D = never,
        E = never,
        F = never,
        G = never,
        H = never,
        I = never,
        J = never,
        K = never,
        L = never,
        M = never,
        N = never,
        O = never,
        P = never,
        Q = never,
        R = never,
        S = never,
        T = never,
        U = never,
    >(
        this: A,
        ab: (_: A) => B,
        bc: (_: B) => C,
        cd: (_: C) => D,
        de: (_: D) => E,
        ef: (_: E) => F,
        fg: (_: F) => G,
        gh: (_: G) => H,
        hi: (_: H) => I,
        ij: (_: I) => J,
        jk: (_: J) => K,
        kl: (_: K) => L,
        lm: (_: L) => M,
        mn: (_: M) => N,
        no: (_: N) => O,
        op: (_: O) => P,
        pq: (_: P) => Q,
        qr: (_: Q) => R,
        rs: (_: R) => S,
        st: (_: S) => T,
        tu: (_: T) => U,
    ): U;
}

Passes the handle through the functions you give, left to right: handle.pipe(f, g) is g(f(handle)).

`Readonly`raw

raw: readonly RawAnswer[]

The answers this visit received from the server, before any decoding; empty on a handle a checkpoint rebuilt.

`Readonly`recentAccounts

recentAccounts: readonly ScreenListItem<
    {
        at: "recentAccounts";
        item: ScreenItemDefinition<
            "RecentSearchAccount",
            { fullName: string; userId: string; username: string },
            { fullName: string; userId: string; username: string },
            RecentSearchAccountState,
            never,
            never,
            RecentSearchAccountItemActions,
            undefined,
            never,
            never,
        >;
        key: "userId";
        source: ScreenNoItemNodes;
    },
    AssembledHandle<
        "SearchInput",
        "screen",
        {
            query: string;
            rankToken: string;
            recentAccounts: readonly {
                fullName: string;
                userId: string;
                username: string;
            }[];
            results: readonly (
                | {
                    __typename: "unknown";
                    item: { kind: "unknown"; kindKey?: string; raw: Json };
                    key: string;
                }
                | {
                    __typename: "XDTTypeaheadSearchKeyword";
                    key: string;
                    keyword_lazified: {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: (...)
                            | (...);
                            id: string;
                            is_private?: (...) | (...) | (...);
                            is_verified?: (...) | (...) | (...);
                            latest_reel_media?: (...) | (...) | (...);
                            profile_pic_url?: (...) | (...);
                            search_serp_type?: (...) | (...) | (...);
                            username: string;
                        }
                        | null;
                    };
                }
                | {
                    __typename: "XDTTypeaheadSearchUser";
                    key: string;
                    rank_token?: string;
                    user: {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    };
                }
                | {
                    __typename: "XDTTypeaheadSearchHashtag";
                    hashtag: { id: string; media_count?: number; name: string };
                    key: string;
                }
                | {
                    __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                    key: string;
                    keywords: readonly {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: ...;
                            id: ...;
                            is_private?: ...;
                            is_verified?: ...;
                            latest_reel_media?: ...;
                            profile_pic_url?: ...;
                            search_serp_type?: ...;
                            username: ...;
                        }
                        | null;
                    }[];
                    num_keywords_to_show?: number;
                    query_text: string;
                }
            )[];
            session?: {
                clientUuidRankToken: string;
                searchSessionId: string;
                serpSessionId?: string;
                typeaheadSessionId: string;
            };
        },
        SearchInputActions,
        SearchInputItems,
        ScreenHandle,
        "required",
        true,
        never,
        AndroidScreens,
    >,
>[]

Your recent searches, shown while the field is empty.

`Readonly`results

results: readonly ScreenListItem<
    {
        at: "results";
        by: "__typename";
        key: "key";
        source: ScreenNoItemNodes;
        variants: {
            unknown: ScreenItemDefinition<
                "SearchInputUnknownResult",
                {
                    __typename: "unknown";
                    item: { kind: "unknown"; kindKey?: string; raw: Json };
                    key: string;
                },
                {
                    __typename: "unknown";
                    item: { kind: "unknown"; kindKey?: string; raw: Json };
                    key: string;
                },
                Record<never, never>,
                never,
                never,
                TypeaheadUnknownResultItemActions,
                undefined,
                never,
                never,
            >;
            XDTTypeaheadSearchHashtag: ScreenItemDefinition<
                "SearchInputHashtagResult",
                {
                    __typename: "XDTTypeaheadSearchHashtag";
                    hashtag: { id: string; media_count?: number; name: string };
                    key: string;
                },
                {
                    __typename: "XDTTypeaheadSearchHashtag";
                    hashtag: { id: string; media_count?: number; name: string };
                    key: string;
                },
                Record<never, never>,
                never,
                never,
                TypeaheadHashtagResultItemActions,
                undefined,
                never,
                never,
            >;
            XDTTypeaheadSearchKeyword: ScreenItemDefinition<
                "SearchInputKeywordResult",
                {
                    __typename: "XDTTypeaheadSearchKeyword";
                    key: string;
                    keyword_lazified: {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        }
                        | null;
                    };
                },
                {
                    __typename: "XDTTypeaheadSearchKeyword";
                    key: string;
                    keyword_lazified: {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: string;
                            id: string;
                            is_private?: boolean;
                            is_verified?: boolean;
                            latest_reel_media?: number
                            | null;
                            profile_pic_url?: string;
                            search_serp_type?: number | null;
                            username: string;
                        }
                        | null;
                    };
                },
                Record<never, never>,
                never,
                never,
                TypeaheadKeywordResultItemActions,
                undefined,
                never,
                never,
            >;
            XDTTypeaheadSearchOverfetchedKeywords: ScreenItemDefinition<
                "SearchInputOverfetchedKeywordsResult",
                {
                    __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                    key: string;
                    keywords: readonly {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: (...)
                            | (...);
                            id: string;
                            is_private?: (...) | (...) | (...);
                            is_verified?: (...) | (...) | (...);
                            latest_reel_media?: (...) | (...) | (...);
                            profile_pic_url?: (...) | (...);
                            search_serp_type?: (...) | (...) | (...);
                            username: string;
                        }
                        | null;
                    }[];
                    num_keywords_to_show?: number;
                    query_text: string;
                },
                {
                    __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                    key: string;
                    keywords: readonly {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: (...)
                            | (...);
                            id: string;
                            is_private?: (...) | (...) | (...);
                            is_verified?: (...) | (...) | (...);
                            latest_reel_media?: (...) | (...) | (...);
                            profile_pic_url?: (...) | (...);
                            search_serp_type?: (...) | (...) | (...);
                            username: string;
                        }
                        | null;
                    }[];
                    num_keywords_to_show?: number;
                    query_text: string;
                },
                Record<never, never>,
                never,
                never,
                TypeaheadOverfetchedKeywordsResultItemActions,
                undefined,
                never,
                never,
            >;
            XDTTypeaheadSearchUser: ScreenItemDefinition<
                "SearchInputUserResult",
                {
                    __typename: "XDTTypeaheadSearchUser";
                    key: string;
                    rank_token?: string;
                    user: {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    };
                },
                {
                    __typename: "XDTTypeaheadSearchUser";
                    key: string;
                    rank_token?: string;
                    user: {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    };
                },
                TypeaheadUserRowState,
                never,
                never,
                TypeaheadUserResultItemActions,
                undefined,
                never,
                never,
            >;
        };
    },
    AssembledHandle<
        "SearchInput",
        "screen",
        {
            query: string;
            rankToken: string;
            recentAccounts: readonly {
                fullName: string;
                userId: string;
                username: string;
            }[];
            results: readonly (
                | {
                    __typename: "unknown";
                    item: { kind: "unknown"; kindKey?: string; raw: Json };
                    key: string;
                }
                | {
                    __typename: "XDTTypeaheadSearchKeyword";
                    key: string;
                    keyword_lazified: {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: (...)
                            | (...);
                            id: string;
                            is_private?: (...) | (...) | (...);
                            is_verified?: (...) | (...) | (...);
                            latest_reel_media?: (...) | (...) | (...);
                            profile_pic_url?: (...) | (...);
                            search_serp_type?: (...) | (...) | (...);
                            username: string;
                        }
                        | null;
                    };
                }
                | {
                    __typename: "XDTTypeaheadSearchUser";
                    key: string;
                    rank_token?: string;
                    user: {
                        full_name?: string;
                        id: string;
                        is_private?: boolean;
                        is_verified?: boolean;
                        latest_reel_media?: number
                        | null;
                        profile_pic_url?: string;
                        search_serp_type?: number | null;
                        username: string;
                    };
                }
                | {
                    __typename: "XDTTypeaheadSearchHashtag";
                    hashtag: { id: string; media_count?: number; name: string };
                    key: string;
                }
                | {
                    __typename: "XDTTypeaheadSearchOverfetchedKeywords";
                    key: string;
                    keywords: readonly {
                        id: string;
                        name: string;
                        user?: | {
                            full_name?: ...;
                            id: ...;
                            is_private?: ...;
                            is_verified?: ...;
                            latest_reel_media?: ...;
                            profile_pic_url?: ...;
                            search_serp_type?: ...;
                            username: ...;
                        }
                        | null;
                    }[];
                    num_keywords_to_show?: number;
                    query_text: string;
                }
            )[];
            session?: {
                clientUuidRankToken: string;
                searchSessionId: string;
                serpSessionId?: string;
                typeaheadSessionId: string;
            };
        },
        SearchInputActions,
        SearchInputItems,
        ScreenHandle,
        "required",
        true,
        never,
        AndroidScreens,
    >,
>[]

The results for the text in the field: keywords, accounts and hashtags, told apart by __typename.

`Readonly`search

search: (
    ...args: readonly [string],
) => Effect<
    AssembledHandle<
        "SearchResultsTopTab",
        "screen",
        {
            query: string;
            session: {
                clientUuidRankToken?: string;
                searchSessionId: string;
                serpSessionId: string;
                typeaheadSessionId?: string;
            };
        },
        SearchResultsTopTabActions,
        Record<never, never>,
        ScreenHandle,
        "required",
        true,
        never,
        AndroidScreens,
    >,

        | IgApiError
        | RequestError
        | ParseError
        | TransportError
        | ScreenEnterConcurrentError
        | ScreenDataError
        | ScreenEdgeInputError,
    never,
>

Taps the keyboard's search key with query: opens the Top results of the search. Answers its handle.

`Readonly`toJSON

toJSON: () => {
    query: string;
    rankToken: string;
    recentAccounts: readonly {
        fullName: string;
        userId: string;
        username: string;
    }[];
    results: readonly (
        | {
            __typename: "unknown";
            item: { kind: "unknown"; kindKey?: string; raw: Json };
            key: string;
        }
        | {
            __typename: "XDTTypeaheadSearchKeyword";
            key: string;
            keyword_lazified: {
                id: string;
                name: string;
                user?: | {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                }
                | null;
            };
        }
        | {
            __typename: "XDTTypeaheadSearchUser";
            key: string;
            rank_token?: string;
            user: {
                full_name?: string;
                id: string;
                is_private?: boolean;
                is_verified?: boolean;
                latest_reel_media?: number
                | null;
                profile_pic_url?: string;
                search_serp_type?: number | null;
                username: string;
            };
        }
        | {
            __typename: "XDTTypeaheadSearchHashtag";
            hashtag: { id: string; media_count?: number; name: string };
            key: string;
        }
        | {
            __typename: "XDTTypeaheadSearchOverfetchedKeywords";
            key: string;
            keywords: readonly {
                id: string;
                name: string;
                user?: | {
                    full_name?: string;
                    id: string;
                    is_private?: boolean;
                    is_verified?: boolean;
                    latest_reel_media?: number
                    | null;
                    profile_pic_url?: string;
                    search_serp_type?: number | null;
                    username: string;
                }
                | null;
            }[];
            num_keywords_to_show?: number;
            query_text: string;
        }
    )[];
    session?: {
        clientUuidRankToken: string;
        searchSessionId: string;
        serpSessionId?: string;
        typeaheadSessionId: string;
    };
}

The handle as JSON: its data.

Interface SearchInputHandle

Index

Properties

Properties

`Readonly`back

`Readonly`change

`Readonly`checkpoint

`Readonly`data

Type Declaration

`Readonly`query: string

`Readonly`rankToken: string

`Readonly`recentAccounts: readonly { fullName: string; userId: string; username: string }[]

`Optional` `Readonly`session?: {
    clientUuidRankToken: string;
    searchSessionId: string;
    serpSessionId?: string;
    typeaheadSessionId: string;
}

`Readonly`id

`Readonly`kind

`Readonly`origin

`Readonly`pipe

`Readonly`raw

`Readonly`recentAccounts

`Readonly`results

`Readonly`search

`Readonly`toJSON

Settings

On This Page

Interface SearchInputHandle

Index

Properties

Properties

Readonlyback

Readonlychange

Readonlycheckpoint

Readonlydata

Type Declaration

Readonlyquery: string

ReadonlyrankToken: string

ReadonlyrecentAccounts: readonly { fullName: string; userId: string; username: string }[]

Optional Readonlysession?: { clientUuidRankToken: string; searchSessionId: string; serpSessionId?: string; typeaheadSessionId: string;}

Readonlyid

Readonlykind

Readonlyorigin

Readonlypipe

Readonlyraw

ReadonlyrecentAccounts

Readonlyresults

Readonlysearch

ReadonlytoJSON

Settings

On This Page

`Readonly`back

`Readonly`change

`Readonly`checkpoint

`Readonly`data

`Readonly`query: string

`Readonly`rankToken: string

`Readonly`recentAccounts: readonly { fullName: string; userId: string; username: string }[]

`Optional` `Readonly`session?: {
clientUuidRankToken: string;
searchSessionId: string;
serpSessionId?: string;
typeaheadSessionId: string;
}

`Readonly`id

`Readonly`kind

`Readonly`origin

`Readonly`pipe

`Readonly`raw

`Readonly`recentAccounts

`Readonly`results

`Readonly`search

`Readonly`toJSON