From ebbde94f87aedd7721c64370f2e5c25e6ec3ad50 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Alexander=20Vassbotn=20R=C3=B8yne-Helgesen?= Date: Tue, 27 Feb 2024 13:12:24 +0100 Subject: [PATCH] =?UTF-8?q?docs:=20=E2=9C=8F=EF=B8=8F=20Do=20not=20generat?= =?UTF-8?q?e=20docs=20from=20tests?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- api/README.md | 10 ---------- api/modules/constants.md | 38 ++++++++++++++++++++++++++++++++++++++ tsconfig.json | 9 ++++++++- 3 files changed, 46 insertions(+), 11 deletions(-) create mode 100644 api/modules/constants.md diff --git a/api/README.md b/api/README.md index 4044324..d2b8ed0 100644 --- a/api/README.md +++ b/api/README.md @@ -11,16 +11,6 @@ - [features/dom](modules/features_dom.md) - [main](modules/main.md) - [types](modules/types.md) -- [utils/\_\_tests\_\_/blob](modules/utils___tests___blob.md) -- [utils/\_\_tests\_\_/code](modules/utils___tests___code.md) -- [utils/\_\_tests\_\_/css](modules/utils___tests___css.md) -- [utils/\_\_tests\_\_/headers](modules/utils___tests___headers.md) -- [utils/\_\_tests\_\_/iframe](modules/utils___tests___iframe.md) -- [utils/\_\_tests\_\_/js](modules/utils___tests___js.md) -- [utils/\_\_tests\_\_/source](modules/utils___tests___source.md) -- [utils/\_\_tests\_\_/style](modules/utils___tests___style.md) -- [utils/\_\_tests\_\_/styles](modules/utils___tests___styles.md) -- [utils/\_\_tests\_\_/wait](modules/utils___tests___wait.md) - [utils/blob](modules/utils_blob.md) - [utils/code](modules/utils_code.md) - [utils/create](modules/utils_create.md) diff --git a/api/modules/constants.md b/api/modules/constants.md new file mode 100644 index 0000000..2a888be --- /dev/null +++ b/api/modules/constants.md @@ -0,0 +1,38 @@ +[@phun-ky/frameport](../README.md) / constants + +# Module: constants + +## Variables + +### DEFAULT\_HEADERS + +• `Const` **DEFAULT\_HEADERS**: `string`[] + +Default meta headers for an HTML document. + +#### Defined in + +[constants/index.ts:27](https://github.com/phun-ky/frameport/blob/main/src/constants/index.ts#L27) + +___ + +### HIDE\_TEMPLATE\_STYLE + +• `Const` **HIDE\_TEMPLATE\_STYLE**: `Object` + +Style object for hiding an element in the HTML. + +#### Type declaration + +| Name | Type | +| :------ | :------ | +| `clip` | `string` | +| `height` | `string` | +| `margin` | `string` | +| `overflow` | `string` | +| `position` | `string` | +| `width` | `string` | + +#### Defined in + +[constants/index.ts:6](https://github.com/phun-ky/frameport/blob/main/src/constants/index.ts#L6) diff --git a/tsconfig.json b/tsconfig.json index 342cfb1..16849e1 100644 --- a/tsconfig.json +++ b/tsconfig.json @@ -16,5 +16,12 @@ "esModuleInterop": true, "resolveJsonModule": true }, - "exclude": ["node_modules", "build", "dist", "scripts", "dts"] + "exclude": [ + "node_modules", + "build", + "dist", + "scripts", + "dts", + "**/__tests__/**" + ] }