Options
All
  • Public
  • Public/Protected
  • All
Menu

Class EsaApi

Hierarchy

  • EsaApi

Index

Constructors

Properties

Methods

Constructors

constructor

  • new EsaApi(__namedParameters: { team: string; token: string }): EsaApi

  • Parameters

    • __namedParameters: { team: string; token: string }
      • team: string
      • token: string

    Returns EsaApi

Properties

Readonly client

client: AxiosInstance

Private Readonly team

team: string

Static Readonly postsPerPageMax

postsPerPageMax: 100 = 100

Methods

getPosts

  • getPosts(__namedParameters?: { includeArray: undefined | ReadonlyArray<"comments" | "comments.stargazers" | "stargazers">; order: undefined | "desc" | "asc"; page: undefined | number; per_page: undefined | number; q: undefined | string; sort: undefined | "number" | "comments" | "updated" | "created" | "stars" | "watches" | "best_match" }): Promise<PostsPayload>

  • Parameters

    • Default value __namedParameters: { includeArray: undefined | ReadonlyArray<"comments" | "comments.stargazers" | "stargazers">; order: undefined | "desc" | "asc"; page: undefined | number; per_page: undefined | number; q: undefined | string; sort: undefined | "number" | "comments" | "updated" | "created" | "stars" | "watches" | "best_match" } = {}
      • includeArray: undefined | ReadonlyArray<"comments" | "comments.stargazers" | "stargazers">
      • order: undefined | "desc" | "asc"
      • page: undefined | number
      • per_page: undefined | number
      • q: undefined | string
      • sort: undefined | "number" | "comments" | "updated" | "created" | "stars" | "watches" | "best_match"

    Returns Promise<PostsPayload>

Generated using TypeDoc