Docstrings streamline

src/api/client.ts

@@ -44,6 +44,12 @@ export class DuneClient {
   /// Table Management Interface
   table: TableAPI;
 
+  /**
+   * Constructor for the DuneClient.
+   *
+   * @param {string} apiKey
+   * @returns Execution Results
+   */
   constructor(apiKey: string) {
     this.exec = new ExecutionAPI(apiKey);
     this.query = new QueryAPI(apiKey);

src/constants.ts

@@ -1,13 +1,21 @@
 import { GetResultParams } from "./types/requestArgs";
 
-// Seconds between checking execution status
+/*
+ * Seconds between checking execution status
+ */
 export const POLL_FREQUENCY_SECONDS = 1;
-// This is the expiry time on old query results.
+/*
+ * This is the expiry time on old query results.
+ */
 export const THREE_MONTHS_IN_HOURS = 2191;
-// Headers used for pagination in CSV results
+/*
+ * Headers used for pagination in CSV results
+ */
 export const DUNE_CSV_NEXT_URI_HEADER = "x-dune-next-uri";
 export const DUNE_CSV_NEXT_OFFSET_HEADER = "x-dune-next-offset";
-// Default maximum number of rows to retrieve per batch of results
+/*
+ * Default maximum number of rows to retrieve per batch of results
+ */
 export const MAX_NUM_ROWS_PER_BATCH = 32_000;
 
 export const DEFAULT_GET_PARAMS: GetResultParams = {

src/types/error.ts

@@ -1,4 +1,6 @@
-/// Basic Error structure meant to represent Dune API errors.
+/*
+ * Basic Error structure meant to represent Dune API errors.
+ */
 export class DuneError extends Error {
   constructor(msg: string) {
     super(msg);

src/types/query.ts

@@ -2,33 +2,57 @@ import { QueryParameter } from "./queryParameter";
 
 /**
  * Enriched structure representing all data constituting a DuneQuery.
- * Modeling the CRUD operation response for `get_query`
+ * Modeling the CRUD operation response for 'get_query'
  * https://docs.dune.com/api-reference/queries/endpoint/read#example-return
  */
 export interface DuneQuery {
-  /// Description of the query.
+  /**
+   * Description of the query.
+   */
   description: string;
-  /// Indicates if the query is archived.
-  /// Note: This is as close as a user can get to deleting a query.
+  /**
+   * Indicates if the query is archived.
+   * Note: This is as close as a user can get to deleting a query.
+   */
   is_archived: boolean;
-  /// Indicates if the query is private.
+  /**
+   * Indicates if the query is private.
+   */
   is_private: boolean;
-  /// Indicates if the query is unsaved.
+  /**
+   * Indicates if the query is unsaved.
+   */
   is_unsaved: boolean;
-  /// Name of the query.
+  /**
+   * Name of the query.
+   */
   name: string;
-  /// Dune user who owns the query.
+  /**
+   * Dune user who owns the query.
+   */
   owner: string;
-  /// Parameters with their names and default values.
+  /**
+   * Parameters with their names and default values.
+   */
   parameters: QueryParameter[];
-  /// The query engine used to execute the query.
+  /**
+   * The query engine used to execute the query.
+   */
   query_engine: string;
-  /// Unique identifier of the query.
+  /**
+   * Unique identifier of the query.
+   */
   query_id: number;
-  /// Raw SQL of the query.
+  /**
+   * Raw SQL of the query.
+   */
   query_sql: string;
-  /// Tags associated with the query.
+  /**
+   * Tags associated with the query.
+   */
   tags: string[];
-  /// Version of the query.
+  /**
+   * Version of the query.
+   */
   version: number;
 }

src/types/queryParameter.ts

@@ -1,4 +1,6 @@
-/// All supported Dune Query Parameter types.
+/*
+ * All supported Dune Query Parameter types.
+ */
 export enum ParameterType {
   /// Note that text fields may also be used for varbinary data types.
   TEXT = "text",
@@ -7,7 +9,9 @@ export enum ParameterType {
   ENUM = "enum",
 }
 
-/// Class representing Dune Query Parameters with convience constructor methods for each type.
+/*
+ * Class representing Dune Query Parameters with convience constructor methods for each type.
+ */
 export class QueryParameter {
   type: ParameterType;
   value: string;