From 88f2881981904284c2aab7facd94695796da7f20 Mon Sep 17 00:00:00 2001
From: shams mosowi <shams.mosowi@gmail.com>
Date: Mon, 14 Oct 2019 09:17:29 +1100
Subject: [PATCH] more documentation

---
 src/hooks/useDoc.ts                   | 1 +
 src/hooks/useFiretable/index.ts       | 2 +-
 src/hooks/useFiretable/useTable.ts    | 6 +++++-
 src/hooks/useFiretable/useUploader.ts | 4 ++--
 src/hooks/useHotkeys.ts               | 7 ++++++-
 src/util/fns.ts                       | 6 ++++++
 6 files changed, 21 insertions(+), 5 deletions(-)

diff --git a/src/hooks/useDoc.ts b/src/hooks/useDoc.ts
index 2bc81400..3f318f79 100644
--- a/src/hooks/useDoc.ts
+++ b/src/hooks/useDoc.ts
@@ -8,6 +8,7 @@ export enum DocActions {
 const documentReducer = (prevState: any, newProps: any) => {
   switch (newProps.action) {
     case DocActions.update:
+      // takes data object form the dispatcher and updates doc
       prevState.ref.update({ ...newProps.data });
       return { ...prevState, doc: { ...prevState.doc, ...newProps.data } };
     case DocActions.delete:
diff --git a/src/hooks/useFiretable/index.ts b/src/hooks/useFiretable/index.ts
index 72f706d1..6f9ef1de 100644
--- a/src/hooks/useFiretable/index.ts
+++ b/src/hooks/useFiretable/index.ts
@@ -38,7 +38,7 @@ const useFiretable = (collectionName: string) => {
   const [tableState, tableActions] = useTable({
     path: collectionName,
   });
-
+  /** set collection path of table */
   const setTable = (collectionName: string, filters: FireTableFilter[]) => {
     configActions.setTable(collectionName);
     tableActions.setTable(collectionName, filters);
diff --git a/src/hooks/useFiretable/useTable.ts b/src/hooks/useFiretable/useTable.ts
index 59b25541..987064cd 100644
--- a/src/hooks/useFiretable/useTable.ts
+++ b/src/hooks/useFiretable/useTable.ts
@@ -5,7 +5,6 @@ import equals from "ramda/es/equals";
 import firebase from "firebase/app";
 import { algoliaUpdateDoc } from "../../firebase/callables";
 import { FireTableFilter } from ".";
-import filter from "ramda/es/filter";
 
 const CAP = 1000; // safety  paramter sets the  upper limit of number of docs fetched by this hook
 
@@ -30,6 +29,11 @@ const useTable = (initialOverrides: any) => {
     ...tableInitialState,
     ...initialOverrides,
   });
+  /**  set collection listener
+   *  @param filters
+   *  @param limit max number of docs
+   *  @param sort
+   */
   const getRows = (
     filters: {
       key: string;
diff --git a/src/hooks/useFiretable/useUploader.ts b/src/hooks/useFiretable/useUploader.ts
index c4bba545..31fa7f73 100644
--- a/src/hooks/useFiretable/useUploader.ts
+++ b/src/hooks/useFiretable/useUploader.ts
@@ -2,13 +2,13 @@ import { useReducer } from "react";
 import { bucket } from "../../firebase/index";
 
 import firebase from "firebase/app";
-const intialState = { progress: 0 };
+const initialState = { progress: 0 };
 const uploadReducer = (prevState: any, newProps: any) => {
   return { ...prevState, ...newProps };
 };
 const useUploader = () => {
   const [uploaderState, uploaderDispatch] = useReducer(uploadReducer, {
-    ...intialState,
+    ...initialState,
   });
 
   const upload = (
diff --git a/src/hooks/useHotkeys.ts b/src/hooks/useHotkeys.ts
index 5c3e2aba..2aa8aea4 100644
--- a/src/hooks/useHotkeys.ts
+++ b/src/hooks/useHotkeys.ts
@@ -2,7 +2,12 @@ import hotkeys, { HotkeysEvent } from "hotkeys-js";
 import { useCallback, useEffect } from "react";
 
 type CallbackFn = (event: KeyboardEvent, handler: HotkeysEvent) => void;
-
+/**
+ * used for listening for keyboard shortcuts
+ * @param keys
+ * @param callback
+ * @param deps
+ */
 export default function useHotkeys(
   keys: string,
   callback: CallbackFn,
diff --git a/src/util/fns.ts b/src/util/fns.ts
index b44904dd..2049e901 100644
--- a/src/util/fns.ts
+++ b/src/util/fns.ts
@@ -1,3 +1,9 @@
+/**
+ * reposition an element in an array
+ * @param arr array
+ * @param old_index index of element to be moved
+ * @param new_index new position of the moved element
+ */
 export const arrayMover = (
   arr: any[],
   old_index: number,