CentreMetre/abstract-ts-table
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

Fix doc typos and add Table class summary line

Browse Source 
Correct 'A object' -> 'An object' and 'if i iss not set' -> 'if it is
not set', and add a one-line summary to the Table class JSDoc.
This commit is contained in:
CentreMetre
2026-06-15 21:15:44 +01:00
parent 95254027c4
commit f5833fcbf8
1 changed files with 3 additions and 2 deletions
Download Patch File Download Diff File Expand all files Collapse all files

5
abstract-table.ts
View File

@@ -4,7 +4,7 @@
*/ */
export type TableOptions<TRow extends object> = { export type TableOptions<TRow extends object> = {
/** /**
* A object with the same properties, but all string type for the header cell values. * An object with the same properties, but all string type for the header cell values.
* Used by passing an object with the keys of {@link TRow} and the name preferred. E.g. for a user: * Used by passing an object with the keys of {@link TRow} and the name preferred. E.g. for a user:
* ```{ id: "ID", name: "Name" }```, this makes the columns appear in the order of ID then Name. * ```{ id: "ID", name: "Name" }```, this makes the columns appear in the order of ID then Name.
*/ */
@@ -23,6 +23,7 @@ export type TableOptions<TRow extends object> = {
}; };
/** /**
* Abstract base class that renders typed row data as an HTML `<table>` on a web page.
* @template TRow A type that the shape of a row should be. E.g. * @template TRow A type that the shape of a row should be. E.g.
* ``` * ```
* type User = { * type User = {
@@ -233,7 +234,7 @@ export abstract class Table<TRow extends object> {
/** /**
* Get the message element for the table. * Get the message element for the table.
* @return The HTMLElement that is used for showing messages. Or null if i iss not set. * @return The HTMLElement that is used for showing messages. Or null if it is not set.
*/ */
getMessageElement(): HTMLElement | null { getMessageElement(): HTMLElement | null {
return this.messageEl; return this.messageEl;