Class Comment

A comment on a user profile.

Implements

Constructors

constructor

Properties

client commentMarkdown commentRenderedHtml createdAt defaultAvatarColorIndex defaultAvatarIndex fetchProfile maybeEditedAt token updatedAt userDisplayName userGravatarHash userToken username

Constructors

constructor

  • new Comment(client, data): Comment

  • Parameters

    • client: Client

      The main client.

    • data: {
          comment_markdown: string;
          comment_rendered_html: string;
          created_at: Date;
          default_avatar_color_index: number;
          default_avatar_index: number;
          maybe_edited_at: null | Date;
          token: string;
          updated_at: Date;
          user_display_name: string;
          user_gravatar_hash: string;
          user_token: string;
          username: string;
      }

      The raw comment data from the FakeYou API.

      • comment_markdown: string
      • comment_rendered_html: string
      • created_at: Date
      • default_avatar_color_index: number
      • default_avatar_index: number
      • maybe_edited_at: null | Date
      • token: string
      • updated_at: Date
      • user_display_name: string
      • user_gravatar_hash: string
      • user_token: string
      • username: string

    Returns Comment

Properties

Readonly client

client: Client

Readonly commentMarkdown

commentMarkdown: string

Readonly commentRenderedHtml

commentRenderedHtml: string

Readonly createdAt

createdAt: Date

Readonly defaultAvatarColorIndex

defaultAvatarColorIndex: number

Readonly defaultAvatarIndex

defaultAvatarIndex: number

fetchProfile

fetchProfile: ((this) => Promise<ProfileUser | undefined>) = implFetchUser

Fetch the user profile of the user who left the comment.

Type declaration

    • (this): Promise<ProfileUser | undefined>

    • Fetch the user profile of the user who left the comment.

      Parameters

      Returns Promise<ProfileUser | undefined>

Readonly maybeEditedAt

maybeEditedAt: null | Date

Readonly token

token: string

The token of the comment. This is NOT the author's user token.

Readonly updatedAt

updatedAt: Date

Readonly userDisplayName

userDisplayName: string

The display name of the user who left the comment.

Readonly userGravatarHash

userGravatarHash: string

Readonly userToken

userToken: string

The token of the user who left the comment.

Readonly username

username: string

The username of the user who left the comment.

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc