@launchdarkly/js-client-sdk-common - v1.35.0
    Preparing search index...

    Interface LDUser

    A LaunchDarkly user object.

    interface LDUser {
        anonymous?: boolean;
        avatar?: string;
        country?: string;
        custom?: {
            [key: string]:
                | string
                | number
                | boolean
                | (string | number | boolean)[];
        };
        email?: string;
        firstName?: string;
        ip?: string;
        key: string;
        lastName?: string;
        name?: string;
        privateAttributeNames?: string[];
    }
    Index
    anonymous? avatar? country? custom? email? firstName? ip? key lastName? name? privateAttributeNames?
    anonymous?: boolean

    If true, the user will not appear on the Users page in the LaunchDarkly dashboard.

    avatar?: string

    An absolute URL to an avatar image for the user.

    country?: string

    The country associated with the user.

    custom?: {
        [key: string]: string | number | boolean | (string | number | boolean)[];
    }

    Any additional attributes associated with the user.

    email?: string

    The user's email address.

    If an avatar URL is not provided, LaunchDarkly will use Gravatar to try to display an avatar for the user on the Users page.

    firstName?: string

    The user's first name.

    ip?: string

    The user's IP address.

    key: string

    A unique string identifying a user.

    lastName?: string

    The user's last name.

    name?: string

    The user's name.

    You can search for users on the User page by name.

    privateAttributeNames?: string[]

    Specifies a list of attribute names (either built-in or custom) which should be marked as private, and not sent to LaunchDarkly in analytics events. This is in addition to any private attributes designated in the global configuration with LDOptions.privateAttributes or LDOptions.allAttributesPrivate.

    Settings
    Member Visibility

    On This Page
    Properties