add some missing types

getsentry · Feb 27, 2024 · 4c1946b · 4c1946b
1 parent ebea37e
commit 4c1946b
Show file tree

Hide file tree

Showing 2 changed files with 5 additions and 2 deletions.
diff --git a/src/files.js b/src/files.js
@@ -17,6 +17,9 @@ const walkDir = fullPath => {
 
 const pathJoinPrefix = prefix => extraPath => path.join(prefix, extraPath);
 
+/**
+ * @returns {string[]} - Array of file paths
+ **/
 const getAllFilesRecursively = folder =>
   pipe(fs.readdirSync, map(pipe(pathJoinPrefix(folder), walkDir)), flattenArray)(folder);
 

diff --git a/src/mdx.ts b/src/mdx.ts
@@ -26,7 +26,7 @@ import remarkVariables from './remark-variables';
 
 const root = process.cwd();
 
-function formatSlug(slug) {
+function formatSlug(slug: string) {
   return slug.replace(/\.(mdx|md)/, '');
 }
 const isSupported = (
@@ -205,7 +205,7 @@ export function getAllFilesFrontMatter(folder: string = 'docs'): FrontMatter[] {
   return allFrontMatter;
 }
 
-export async function getFileBySlug(slug) {
+export async function getFileBySlug(slug: string) {
   const configPath = path.join(root, slug, 'config.yml');
   let configFrontmatter: {[key: string]: any} | undefined;
   if (fs.existsSync(configPath)) {