add jsdoc to performanceDbApi

digital-land · Jul 12, 2024 · 8511c19 · 8511c19
1 parent 7609f6e
commit 8511c19
Showing 1 changed file with 24 additions and 2 deletions.
diff --git a/src/services/performanceDbApi.js b/src/services/performanceDbApi.js
@@ -1,10 +1,32 @@
+/**
+ * Performance DB API service
+ */
 import datasette from './datasette.js'
 
-/*
+/**
+ * @typedef {object} Dataset
+ * @property {string} endpoint
+ * @property {?string} error
+ * @property {?string} issue
+ */
 
-*/
+/**
+ * @typedef {object} LpaOverview
+ * @property {string} name
+ * @property {{ [dataset: string]: Dataset }} datasets
+ */
 
+/**
+ * Performance DB API service
+ * @export
+ * @default
+ */
 export default {
+  /**
+   * Get LPA overview
+   * @param {string} lpa - LPA ID
+   * @returns {Promise<LpaOverview>} LPA overview
+   */
   getLpaOverview: async (lpa) => {
     const query = `
     SELECT