Get a repository README

type Github = {

  token: string;

};

/**

 * Get a repository README

 * Gets the preferred README for a repository.

READMEs support [custom media types](https://docs.github.com/rest/reference/repos#custom-media-types) for retrieving the raw content or rendered HTML.

 */

export async function main(

  auth: Github,

  owner: string,

  repo: string,

  ref: string | undefined

) {

  const url = new URL(`https://api.github.com/repos/${owner}/${repo}/readme`);

  for (const [k, v] of [["ref", ref]]) {

    if (v !== undefined && v !== "") {

      url.searchParams.append(k, v);

    }

  }

  const response = await fetch(url, {

    method: "GET",

    headers: {

      Authorization: "Bearer " + auth.token,

    },

    body: undefined,

  });

  if (!response.ok) {

    const text = await response.text();

    throw new Error(`${response.status} ${text}`);

  }

  return await response.json();

}