fix: add jsdoc comments

This commit is contained in:
Stevan Freeborn
2023-02-10 23:29:56 -06:00
parent 0af3a9d7ca
commit 287289b83f
3 changed files with 26 additions and 0 deletions
+5
View File
@@ -4,6 +4,11 @@ import { CreatedWithIdResponse } from './CreatedWithIdResponse';
* @class ListItemResponse - Represents a respons when a list item is created or updated.
*/
export class ListItemResponse extends CreatedWithIdResponse {
/**
* @constructor - Creates a new instance of ListItemResponse.
* @param {number} id - The id of the list item.
* @returns {ListItemResponse} - A new instance of ListItemResponse.
*/
constructor(id: number) {
super(id);
}
+5
View File
@@ -310,6 +310,11 @@ export class OnspringClient {
return apiResponse;
}
/**
* @method getRecordById - Gets a record by its id.
* @param {GetRecordRequest} request - The request that will be used to get the record.
* @returns {Promise<ApiResponse<Record>>} - A promise that resolves to an ApiResponse of type Record.
*/
public async getRecordById(
request: GetRecordRequest
): Promise<ApiResponse<Record>> {
+16
View File
@@ -1,9 +1,25 @@
import { type Row } from './Row';
/**
* @class ReportData - Represents the data for a report.
*/
export class ReportData {
/**
* @property {string[]} columns - The columns in the report.
*/
public columns: string[];
/**
* @property {Row[]} rows - The rows in the report.
*/
public rows: Row[];
/**
* @constructor - Creates a new instance of ReportData.
* @param {string[]} columns - The columns in the report.
* @param {Row[]} rows - The rows in the report.
* @returns {ReportData} - A new instance of ReportData.
*/
constructor(columns: string[], rows: Row[]) {
this.columns = columns;
this.rows = rows;