distype - v3.0.1
    Preparing search index...

    Interface CacheOptions

    Cache options.

    interface CacheOptions {
        channels?:
            | null
            | (
                | "name"
                | "type"
                | "position"
                | "managed"
                | "flags"
                | "applied_tags"
                | "thread_metadata"
                | "message_count"
                | "member_count"
                | "owner_id"
                | "total_message_sent"
                | "last_message_id"
                | "rate_limit_per_user"
                | "guild_id"
                | "permission_overwrites"
                | "parent_id"
                | "nsfw"
                | "last_pin_timestamp"
                | "recipients"
                | "application_id"
                | "icon"
                | "default_forum_layout"
                | "topic"
                | "default_auto_archive_duration"
                | "available_tags"
                | "default_thread_rate_limit_per_user"
                | "default_reaction_emoji"
                | "default_sort_order"
                | "bitrate"
                | "user_limit"
                | "rtc_region"
                | "video_quality_mode"
            )[];
        guilds?: | null
        | (
            | "name"
            | "description"
            | "region"
            | "roles"
            | "joined_at"
            | "banner"
            | "member_count"
            | "owner_id"
            | "application_id"
            | "icon"
            | "permissions"
            | "members"
            | "channels"
            | "stickers"
            | "splash"
            | "features"
            | "verification_level"
            | "vanity_url_code"
            | "welcome_screen"
            | "icon_hash"
            | "discovery_splash"
            | "owner"
            | "afk_channel_id"
            | "afk_timeout"
            | "widget_enabled"
            | "widget_channel_id"
            | "default_message_notifications"
            | "explicit_content_filter"
            | "emojis"
            | "mfa_level"
            | "system_channel_id"
            | "system_channel_flags"
            | "rules_channel_id"
            | "max_presences"
            | "max_members"
            | "premium_tier"
            | "premium_subscription_count"
            | "preferred_locale"
            | "public_updates_channel_id"
            | "max_video_channel_users"
            | "max_stage_video_channel_users"
            | "approximate_member_count"
            | "approximate_presence_count"
            | "nsfw_level"
            | "premium_progress_bar_enabled"
            | "hub_type"
            | "safety_alerts_channel_id"
            | "incidents_data"
            | "large"
            | "unavailable"
            | "stage_instances"
            | "guild_scheduled_events"
            | "soundboard_sounds"
        )[];
        members?: | null
        | (
            | "mute"
            | "pending"
            | "user"
            | "roles"
            | "flags"
            | "avatar"
            | "communication_disabled_until"
            | "deaf"
            | "joined_at"
            | "nick"
            | "premium_since"
            | "avatar_decoration_data"
            | "banner"
        )[];
        presences?: null
        | ("status" | "user" | "activities" | "client_status")[];
        roles?:
            | null
            | (
                | "name"
                | "color"
                | "position"
                | "managed"
                | "flags"
                | "guild_id"
                | "icon"
                | "permissions"
                | "tags"
                | "colors"
                | "hoist"
                | "unicode_emoji"
                | "mentionable"
            )[];
        users?: | null
        | (
            | "username"
            | "email"
            | "flags"
            | "avatar"
            | "avatar_decoration_data"
            | "banner"
            | "locale"
            | "discriminator"
            | "global_name"
            | "bot"
            | "system"
            | "mfa_enabled"
            | "accent_color"
            | "verified"
            | "premium_type"
            | "public_flags"
            | "avatar_decoration"
            | "collectibles"
        )[];
        voiceStates?: | null
        | (
            | "mute"
            | "deaf"
            | "member"
            | "channel_id"
            | "session_id"
            | "self_deaf"
            | "self_mute"
            | "suppress"
            | "self_stream"
            | "self_video"
            | "request_to_speak_timestamp"
        )[];
    }
    Index

    Properties

    channels? guilds? members? presences? roles? users? voiceStates?

    Properties

    channels?:
        | null
        | (
            | "name"
            | "type"
            | "position"
            | "managed"
            | "flags"
            | "applied_tags"
            | "thread_metadata"
            | "message_count"
            | "member_count"
            | "owner_id"
            | "total_message_sent"
            | "last_message_id"
            | "rate_limit_per_user"
            | "guild_id"
            | "permission_overwrites"
            | "parent_id"
            | "nsfw"
            | "last_pin_timestamp"
            | "recipients"
            | "application_id"
            | "icon"
            | "default_forum_layout"
            | "topic"
            | "default_auto_archive_duration"
            | "available_tags"
            | "default_thread_rate_limit_per_user"
            | "default_reaction_emoji"
            | "default_sort_order"
            | "bitrate"
            | "user_limit"
            | "rtc_region"
            | "video_quality_mode"
        )[]

    Channel cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    guilds?:
        | null
        | (
            | "name"
            | "description"
            | "region"
            | "roles"
            | "joined_at"
            | "banner"
            | "member_count"
            | "owner_id"
            | "application_id"
            | "icon"
            | "permissions"
            | "members"
            | "channels"
            | "stickers"
            | "splash"
            | "features"
            | "verification_level"
            | "vanity_url_code"
            | "welcome_screen"
            | "icon_hash"
            | "discovery_splash"
            | "owner"
            | "afk_channel_id"
            | "afk_timeout"
            | "widget_enabled"
            | "widget_channel_id"
            | "default_message_notifications"
            | "explicit_content_filter"
            | "emojis"
            | "mfa_level"
            | "system_channel_id"
            | "system_channel_flags"
            | "rules_channel_id"
            | "max_presences"
            | "max_members"
            | "premium_tier"
            | "premium_subscription_count"
            | "preferred_locale"
            | "public_updates_channel_id"
            | "max_video_channel_users"
            | "max_stage_video_channel_users"
            | "approximate_member_count"
            | "approximate_presence_count"
            | "nsfw_level"
            | "premium_progress_bar_enabled"
            | "hub_type"
            | "safety_alerts_channel_id"
            | "incidents_data"
            | "large"
            | "unavailable"
            | "stage_instances"
            | "guild_scheduled_events"
            | "soundboard_sounds"
        )[]

    Guild cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    members?:
        | null
        | (
            | "mute"
            | "pending"
            | "user"
            | "roles"
            | "flags"
            | "avatar"
            | "communication_disabled_until"
            | "deaf"
            | "joined_at"
            | "nick"
            | "premium_since"
            | "avatar_decoration_data"
            | "banner"
        )[]

    Member cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    presences?: null | ("status" | "user" | "activities" | "client_status")[]

    Presence cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    roles?:
        | null
        | (
            | "name"
            | "color"
            | "position"
            | "managed"
            | "flags"
            | "guild_id"
            | "icon"
            | "permissions"
            | "tags"
            | "colors"
            | "hoist"
            | "unicode_emoji"
            | "mentionable"
        )[]

    Role cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    users?:
        | null
        | (
            | "username"
            | "email"
            | "flags"
            | "avatar"
            | "avatar_decoration_data"
            | "banner"
            | "locale"
            | "discriminator"
            | "global_name"
            | "bot"
            | "system"
            | "mfa_enabled"
            | "accent_color"
            | "verified"
            | "premium_type"
            | "public_flags"
            | "avatar_decoration"
            | "collectibles"
        )[]

    User cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null
    voiceStates?:
        | null
        | (
            | "mute"
            | "deaf"
            | "member"
            | "channel_id"
            | "session_id"
            | "self_deaf"
            | "self_mute"
            | "suppress"
            | "self_stream"
            | "self_video"
            | "request_to_speak_timestamp"
        )[]

    Voice state cache control. By default, nothing is cached. Cache is enabled on a per-key basis, meaning you specify what keys of data you wish to keep cached. Keep in mind that even if you select to cache data, that data may not be available until specific gateway dispatches are received. Defining an empty array ([]) will only cache the required data, null or undefined will cache no data.

    null

    Settings

    Member Visibility

    On This Page

    Properties