docs: add comments

kagawagao · Feb 18, 2022 · a9bb01f · a9bb01f
1 parent 6095b6f
commit a9bb01f
Show file tree

Hide file tree

Showing 2 changed files with 3 additions and 1 deletion.
diff --git a/README.md b/README.md
@@ -59,5 +59,5 @@ plugins: [
 
 ## Options
 
-- `externals: <HTMLTagObject>[]`: external [HTMLTagObject](https://github.com/jantimon/html-webpack-plugin/blob/6e17a0cd7e99c08fdf6eb6e79b88f589af35c645/typings.d.ts#L238-L260) which you want to add
+- `externals: <HtmlAssetItem>[]`: external HTMLTagObject which you want to add
 - `prepend`: insert before parent first child
diff --git a/src/index.ts b/src/index.ts
@@ -10,6 +10,8 @@ export interface ExternalItem extends Omit<HtmlTagObject, 'voidTag' | 'meta'> {
   include?: IncludeFilter
 }
 
+// extends HtmlTagObject
+// https://github.com/jantimon/html-webpack-plugin/blob/6e17a0cd7e99c08fdf6eb6e79b88f589af35c645/typings.d.ts#L238-L260
 export interface HtmlAssetItem extends HtmlTagObject {
   include?: IncludeFilter
 }