Class default

constructor

• new default(url, username): default

• Represents a Forgejo instance.

  Parameters

  • url: string

    The URL of the Forgejo instance

  • username: string

    username of the logged in user

  Returns default

Optional token

url

username

findMentionsInIssue

• findMentionsInIssue(owner, repo, id): Promise<boolean>

• Check if logged in user is mentioned in the issue

  Parameters

  • owner: string

  • repo: string

  • id: number

  Returns Promise<boolean>

getCommentsForIssue

• getCommentsForIssue(issue): Promise<Issue>

• Parameters

  • issue: Issue

  Returns Promise<Issue>

getIssue

• getIssue(owner, repo, id): Promise<Issue>

• Get Issue and its comments

  Parameters

  • owner: string

    The owner of the repository

  • repo: string

    The name of the repository

  • id: number

    The ID of an issue

  Returns Promise<Issue>

getNotificationThread

• getNotificationThread(id): Promise<Notification>

• Get Notification Thread

  Parameters

  • id: number

    The ID of a notification thread

  Returns Promise<Notification>

getNotifications

• getNotifications(): Promise<Notification[]>

• Get all notifications

  Returns Promise<Notification[]>

getNumUnreadNotifications

• getNumUnreadNotifications(): Promise<number>

• Get number of unread notifications

  Returns Promise<number>

getTokenAuth

• getTokenAuth(): Auth

• Returns Auth

getTokenAuthHeader

• getTokenAuthHeader(): {
      Authorization: string;
  }

• Returns {
      Authorization: string;
  }

  • Authorization: string

getUser

• getUser(): Promise<User>

• Get logged in user

  Returns Promise<User>

lastReadTime

• lastReadTime(issue): Date

• Get the time at which the issue was last read

  Parameters

  • issue: Issue

  Returns Date

markNotificationRead

• markNotificationRead(id): Promise<void>

• Mark Notification Read

  Parameters

  • id: number

    The ID of a notification thread

  Returns Promise<void>

markNotificationReadForRepo

• markNotificationReadForRepo(owner, repo): Promise<void>

• Mark Notification Read for a specific repository

  Parameters

  • owner: string

    Name of the owner of the repository

  • repo: string

    Name of the repository

  Returns Promise<void>

setTokenAuth

• setTokenAuth(token): void

• Authenticate with token

  Parameters

  • token: string

    access token

  Returns void