Merge pull request #25 from roebi/24-add-declaration-in-tsconfigjson

24 add declaration in tsconfig.json

Author: roebi

README.md

@@ -29,7 +29,7 @@ export async function getGithubTopicsFromGithub() {
   const infoLog = true;
   const isProd = true;
 
-  const githubTopics = getGithubTopics(loginName, projectName, infoLog, isProd) as Promise<String[]>;
+  const githubTopics = getGithubTopics(loginName, projectName, infoLog, isProd) as Promise<string[]>;
 
   const realGithubTopics = await githubTopics;
   console.group("realGithubTopics");

consts.d.ts

@@ -0,0 +1,2 @@
+export declare const GITHUB_API_BASE_URL = "https://api.github.com/";
+export declare const GITHUB_HTML_BASE_URL = "https://github.com/";

coverage/consts.js.html

@@ -86,7 +86,7 @@ <h1><a href="index.html">All files</a> consts.js</h1>
     <div class="footer quiet pad2 space-top1 center small">
       Code coverage generated by
       <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-      at 2023-09-19T23:40:19.793Z
+      at 2023-09-20T10:23:53.845Z
     </div>
     <script src="prettify.js"></script>
     <script>

coverage/githubApiGet.js.html

@@ -235,11 +235,11 @@ <h1><a href="index.html">All files</a> githubApiGet.js</h1>
  * @remarks
  * This method is part of the {@link githubApi | github-api}.
  *
- * @param {String} loginName - The github login name
- * @param {String} projectName - The github project name
+ * @param {string} loginName - The github login name
+ * @param {string} projectName - The github project name
  * @param {boolean} infoLog - true Logs group and info into the console
  * @param {boolean} isProd - true Calls fetch to github api, false returns mock data with same structure
- * @returns {Promise&lt;String[]&gt;} The github topics of a project
+ * @returns {Promise&lt;string[]&gt;} The github topics of a project
  */
 export async function getGithubTopics(loginName, projectName, infoLog, isProd) {
     if (infoLog) {
@@ -269,8 +269,8 @@ <h1><a href="index.html">All files</a> githubApiGet.js</h1>
  * @remarks
  * This method is part of the {@link githubApi | github-api}.
  *
- * @param {String} loginName - The github login name
- * @param {String} projectName - The github project name
+ * @param {string} loginName - The github login name
+ * @param {string} projectName - The github project name
  * @param {boolean} infoLog - true Logs group and info into the console
  * @param {boolean} isProd - true Calls fetch to github api, false returns mock data with same structure
  * @returns {Promise&lt;any&gt;} The github the project object / json of a project
@@ -317,7 +317,7 @@ <h1><a href="index.html">All files</a> githubApiGet.js</h1>
     <div class="footer quiet pad2 space-top1 center small">
       Code coverage generated by
       <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-      at 2023-09-19T23:40:19.793Z
+      at 2023-09-20T10:23:53.845Z
     </div>
     <script src="prettify.js"></script>
     <script>

coverage/index.html

@@ -117,7 +117,7 @@ <h1>All files</h1>
     <div class="footer quiet pad2 space-top1 center small">
       Code coverage generated by
       <a href="https://istanbul.js.org/" target="_blank" rel="noopener noreferrer">istanbul</a>
-      at 2023-09-19T23:40:19.793Z
+      at 2023-09-20T10:23:53.845Z
     </div>
     <script src="prettify.js"></script>
     <script>