From 09ff261f156a8599d45c1496fe246ded6e035191 Mon Sep 17 00:00:00 2001 From: HampusM Date: Mon, 26 Jul 2021 23:56:53 +0200 Subject: Added backend TSDoc/JSDoc comments & refactored a tiny bit --- packages/server/src/git/misc.ts | 20 ++++++++++++++++++++ 1 file changed, 20 insertions(+) (limited to 'packages/server/src/git/misc.ts') diff --git a/packages/server/src/git/misc.ts b/packages/server/src/git/misc.ts index bd18322..da9b1ee 100644 --- a/packages/server/src/git/misc.ts +++ b/packages/server/src/git/misc.ts @@ -1,12 +1,26 @@ import { readFile, readdir } from "fs"; import { createError, MiscError } from "./error"; +/** + * Asynchronously find an item in an array that matches the requirements set by the callback + * + * @param arr - The array to look in + * @param callback - A callback that knowns what you're looking for + * @returns The item in the array you wanted to find + */ export async function findAsync(arr: T[], callback: (t: T) => Promise): Promise { const results = await Promise.all(arr.map(callback)); const index = results.findIndex(result => result); return arr[index]; } +/** + * Returns the content of a file inside a repository + * + * @param base_dir - The directory which the repository is in + * @param repository - The directory of a bare repository + * @param file - The path of a file + */ export function getFile(base_dir: string, repository: string, file: string): Promise { return new Promise((resolve, reject) => { readFile(`${base_dir}/${repository}/${file}`, (err, content) => { @@ -20,6 +34,12 @@ export function getFile(base_dir: string, repository: string, file: string): Pro }); } +/** + * Returns all of the files & folders inside of a directory + * + * @param directory - The directory to look in + * @returns An array of directory content + */ export function getDirectory(directory: string): Promise { return new Promise((resolve, reject) => { readdir(directory, (err, dir_content) => { -- cgit v1.2.3-18-g5258