Skip to content

Commit ac9abe2

Browse files
authored
Fix all typedoc warnings (#77)
2 parents 710230d + 515d75b commit ac9abe2

File tree

4 files changed

+8
-8
lines changed

4 files changed

+8
-8
lines changed

src/Component.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -16,11 +16,11 @@
1616
*/
1717
import {ElementComponent} from "./index.js";
1818

19-
type ElementToTagName<T extends HTMLElement> = {
19+
export type ElementToTagName<T extends HTMLElement> = {
2020
[K in keyof HTMLElementTagNameMap]: HTMLElementTagNameMap[K] extends T ? K : never
2121
}[keyof HTMLElementTagNameMap];
2222

23-
type HtmlTagString<T extends HTMLElement> =
23+
export type HtmlTagString<T extends HTMLElement> =
2424
`<${{ [K in keyof HTMLElementTagNameMap]: HTMLElementTagNameMap[K] extends T ? K : never }[keyof HTMLElementTagNameMap]}>${string}`
2525
| `<${{ [K in keyof HTMLElementTagNameMap]: HTMLElementTagNameMap[K] extends T ? K : never }[keyof HTMLElementTagNameMap]} ${string}`;
2626

src/DocumentComponent.ts

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -28,7 +28,7 @@ export class DocumentComponent extends NodeComponent<DocumentFragment> {
2828
* Template literal tag function that accepts HTML code with components in a
2929
* string literal
3030
*
31-
* @warning This method should only be used with trusted inputs
31+
* @remarks This method should only be used with trusted inputs
3232
* to avoid XSS vulnerabilities.
3333
*/
3434
public static tag(strings: TemplateStringsArray, ...components: (any | NodeComponent<any>)[]): DocumentComponent {

src/ElementComponent.ts

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ import {DocumentComponent, NodeComponent} from "./index.js";
1919
/**
2020
* Non-readonly non-method keys
2121
*/
22-
type WritableKeys<T> = {
22+
export type WritableKeys<T> = {
2323
[Prop in keyof T]: (
2424
(<G>() => G extends Pick<T, Prop> ? 1 : 2) extends (
2525
<G>() => G extends Record<Prop, T[Prop]> ? 1 : 2
@@ -32,7 +32,7 @@ type WritableKeys<T> = {
3232
/**
3333
* Non-method keys
3434
*/
35-
type ReadableKeys<T> = {
35+
export type ReadableKeys<T> = {
3636
[Prop in keyof T]: T[Prop] extends Function | null | undefined ? never : Prop;
3737
}[keyof T];
3838

@@ -106,7 +106,7 @@ export abstract class ElementComponent<T extends Element> extends NodeComponent<
106106
* Replace classes
107107
*
108108
* @param oldClasses If all of these classes are present, they will be removed.
109-
* @param newClasses The classes to add if all {@link oldClasses} are present
109+
* @param newClasses The classes to add if all `oldClasses` are present
110110
*/
111111
public replaceClass(oldClasses: string | string[], newClasses: string | string[]) {
112112
const remove = (typeof oldClasses === "string" ? [oldClasses] : oldClasses).flatMap(c => c.split(" "));

src/index.ts

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,6 +17,6 @@
1717
export {NodeComponent} from "./NodeComponent.js";
1818
export {DocumentComponent} from "./DocumentComponent.js";
1919
export {TextComponent} from "./TextComponent.js";
20-
export {ElementComponent} from "./ElementComponent.js";
21-
export {Component} from "./Component.js";
20+
export {ElementComponent, ReadableKeys, WritableKeys} from "./ElementComponent.js";
21+
export {Component, ElementToTagName, HtmlTagString} from "./Component.js";
2222
export {SvgComponent} from "./SvgComponent.js";

0 commit comments

Comments
 (0)