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

    Interface EditProfileUsernameActions

    The actions of EditProfileUsernameScreen: the methods you call on its handle while the screen is open.

    interface EditProfileUsernameActions {
        changeUsername: (
            ...args: [username: string],
        ) => Effect<
            UpdateProfileUsernameResponse & { raw: ActionRaw },

                | IgApiError
                | RequestError
                | ParseError
                | TransportError
                | ScreenEnterConcurrentError,
            never,
        >;
        typeUsername: <Self extends ScreenHandle>(
            this: Self,
            ...args: [username: string],
        ) => Effect<
            Self,
            ScreenDataActionFailure<
                IgApiError
                | RequestError
                | ParseError
                | TransportError,
            >,
            never,
        >;
    }
    Index

    Properties

    changeUsername: (
        ...args: [username: string],
    ) => Effect<
        UpdateProfileUsernameResponse & { raw: ActionRaw },

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

    Taps Done: saves the new username (username). Answers the saved profile.

    typeUsername: <Self extends ScreenHandle>(
        this: Self,
        ...args: [username: string],
    ) => Effect<
        Self,
        ScreenDataActionFailure<
            IgApiError
            | RequestError
            | ParseError
            | TransportError,
        >,
        never,
    >

    Types a username (username) and checks whether it is available. Answers the screen shown again; its data.check.available says whether the name is free.