ci(docs-infra): add explicit return types to methods

aio/aio-builds-setup/dockerbuild/scripts-js/lib/common/circle-ci-api.ts

@@ -55,7 +55,7 @@ export class CircleCiApi {
    * @param buildNumber The CircleCI build number that generated the artifact.
    * @returns A promise to the info about the build
    */
-  public async getBuildInfo(buildNumber: number) {
+  public async getBuildInfo(buildNumber: number): Promise<BuildInfo> {
     try {
       const baseUrl = `${CIRCLE_CI_API_URL}/${this.githubOrg}/${this.githubRepo}/${buildNumber}`;
       const response = await fetch(`${baseUrl}?${this.tokenParam}`);
@@ -73,7 +73,7 @@ export class CircleCiApi {
    * @param artifactPath The path, within the build to the artifact.
    * @returns A promise to the URL that can be requested to download the actual build artifact file.
    */
-  public async getBuildArtifactUrl(buildNumber: number, artifactPath: string) {
+  public async getBuildArtifactUrl(buildNumber: number, artifactPath: string): Promise<string> {
     const baseUrl = `${CIRCLE_CI_API_URL}/${this.githubOrg}/${this.githubRepo}/${buildNumber}`;
     try {
       const response = await fetch(`${baseUrl}/artifacts?${this.tokenParam}`);

aio/aio-builds-setup/dockerbuild/scripts-js/lib/common/github-api.ts

@@ -56,7 +56,7 @@ export class GithubApi {
   }
 
   // Methods - Protected
-  protected buildPath(pathname: string, params?: RequestParamsOrNull) {
+  protected buildPath(pathname: string, params?: RequestParamsOrNull): string {
     if (params == null) {
       return pathname;
     }
@@ -67,7 +67,7 @@ export class GithubApi {
     return `${pathname}${joiner}${search}`;
   }
 
-  protected request<T>(method: string, path: string, data: any = null) {
+  protected request<T>(method: string, path: string, data: any = null): Promise<T> {
     return new Promise<T>((resolve, reject) => {
       const options = {
         headers: {...this.requestHeaders},
@@ -101,7 +101,7 @@ export class GithubApi {
     });
   }
 
-  protected serializeSearchParams(params: RequestParams) {
+  protected serializeSearchParams(params: RequestParams): string {
     return Object.keys(params).
       filter(key => params[key] != null).
       map(key => `${key}=${encodeURIComponent(String(params[key]))}`).

aio/aio-builds-setup/dockerbuild/scripts-js/lib/common/github-pull-requests.ts

@@ -38,7 +38,7 @@ export class GithubPullRequests {
    * @param body The body of the comment to post.
    * @returns A promise that resolves when the comment has been posted.
    */
-  public addComment(pr: number, body: string) {
+  public addComment(pr: number, body: string): Promise<any> {
     assert(pr > 0, `Invalid PR number: ${pr}`);
     assert(!!body, `Invalid or empty comment body: ${body}`);
     return this.api.post<any>(`/repos/${this.repoSlug}/issues/${pr}/comments`, null, {body});
@@ -49,7 +49,7 @@ export class GithubPullRequests {
    * @param pr The number of the PR for which to request info.
    * @returns A promise that is resolves with information about the specified PR.
    */
-  public fetch(pr: number) {
+  public fetch(pr: number): Promise<PullRequest> {
     assert(pr > 0, `Invalid PR number: ${pr}`);
     // Using the `/issues/` URL, because the `/pulls/` one does not provide labels.
     return this.api.get<PullRequest>(`/repos/${this.repoSlug}/issues/${pr}`);
@@ -60,7 +60,7 @@ export class GithubPullRequests {
    * @param state Only retrieve PRs that have this state.
    * @returns A promise that is resolved with information about the requested PRs.
    */
-  public fetchAll(state: PullRequestState = 'all') {
+  public fetchAll(state: PullRequestState = 'all'): Promise<PullRequest[]> {
     const pathname = `/repos/${this.repoSlug}/pulls`;
     const params = {state};
 
@@ -72,7 +72,7 @@ export class GithubPullRequests {
    * @param pr The number of the PR for which to request files.
    * @returns A promise that resolves to an array of file information
    */
-  public fetchFiles(pr: number) {
+  public fetchFiles(pr: number): Promise<FileInfo[]> {
     assert(pr > 0, `Invalid PR number: ${pr}`);
     return this.api.get<FileInfo[]>(`/repos/${this.repoSlug}/pulls/${pr}/files`);
   }

aio/aio-builds-setup/dockerbuild/scripts-js/lib/common/github-teams.ts

@@ -24,7 +24,7 @@ export class GithubTeams {
    * Request information about all the organisation's teams in GitHub.
    * @returns A promise that is resolved with information about the teams.
    */
-  public fetchAll() {
+  public fetchAll(): Promise<Team[]> {
     return this.api.getPaginated<Team>(`/orgs/${this.githubOrg}/teams`);
   }
 
@@ -34,7 +34,7 @@ export class GithubTeams {
    * @param teamIds The team to check for the username.
    * @returns a Promise that resolves to `true` if the username is a member of the team.
    */
-  public async isMemberById(username: string, teamIds: number[]) {
+  public async isMemberById(username: string, teamIds: number[]): Promise<boolean> {
 
     const getMembership = async (teamId: number) => {
       try {
@@ -60,7 +60,7 @@ export class GithubTeams {
    * @param teamSlugs A collection of slugs that represent the teams to check for the the username.
    * @returns a Promise that resolves to `true` if the usernane is a member of at least one of the specified teams.
    */
-  public async isMemberBySlug(username: string, teamSlugs: string[]) {
+  public async isMemberBySlug(username: string, teamSlugs: string[]): Promise<boolean> {
     try {
       const teams = await this.fetchAll();
       const teamIds = teams.filter(team => teamSlugs.includes(team.slug)).map(team => team.id);