Remove mention of Heist for User

This commit is contained in:
CentreMetre
2026-06-14 16:29:47 +01:00
parent bc602c7bd8
commit 3b0cb99334

View File

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