diff --git a/abstract-table.ts b/abstract-table.ts index 4b54488..8d0fe47 100644 --- a/abstract-table.ts +++ b/abstract-table.ts @@ -1,12 +1,12 @@ /** * @template R A type that the shape of a row should be. E.g. * ``` - * type Heist = { + * type User = { * id: number; * name: string; * } * ``` - * Then `Heist` would be passed as the generic. + * Then `User` would be passed as the generic. */ export abstract class Table { @@ -18,11 +18,11 @@ export abstract class Table { /** * Creates a list of Header objects to be used in a table for the header cell values and column types. - * @param exampleObject An instance of the type to be displaying. Can be an object with default values such as - * `0`, `""`, `false` or `true`. E.g. for a heist ```{ id: 0; name: ""; }``` + * @param exampleObject An instance of the type to be displaying. Can be an object with default/zero values for that type + * such as `0`, `""`, `false` or `true`. E.g. for a user ```{ id: 0; name: ""; }``` would be passed * @param displayNamesAndOrder A object with the same properties, but all string type for the header cell values. - * Used by passing an object with the keys of R and the name preferred. E.g. for a heist: - * ```{ id: "ID", name: "Heist Name" }```, this makes the columns appear in the order of ID then Heist Name. + * Used by passing an object with the keys of R 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. * @param messageElement Used to display messaged related to data output. Optional. * Omit (undefined) to use the class provided HTMLParagraphElement. * Pass an HTMLElement tp ise a custom element.