feat(audits/render): Render audit results to HTML with `renderAuditRe…

…sultsToHTML` (#53) Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
graphql · Feb 12, 2023 · da32059 · da32059
1 parent 3d9f67d
commit da32059
Show file tree

Hide file tree

Showing 19 changed files with 7,455 additions and 7,879 deletions.
diff --git a/docs/README.md b/docs/README.md
@@ -7,6 +7,7 @@ graphql-http
 ### Modules
 
 - [audits/common](modules/audits_common.md)
+- [audits/render](modules/audits_render.md)
 - [audits/server](modules/audits_server.md)
 - [client](modules/client.md)
 - [common](modules/common.md)

diff --git a/docs/modules/audits_render.md b/docs/modules/audits_render.md
@@ -0,0 +1,30 @@
+[graphql-http](../README.md) / audits/render
+
+# Module: audits/render
+
+## Table of contents
+
+### Functions
+
+- [renderAuditResultsToHTML](audits_render.md#renderauditresultstohtml)
+
+## Functions
+
+### renderAuditResultsToHTML
+
+▸ **renderAuditResultsToHTML**(`results`): `Promise`<`string`\>
+
+Renders the provided audit results to well-formatted and valid HTML.
+
+Do note that the rendered result is not an HTML document, it's rather
+just a component with results.
+
+#### Parameters
+
+| Name | Type |
+| :------ | :------ |
+| `results` | [`AuditResult`](audits_common.md#auditresult)[] |
+
+#### Returns
+
+`Promise`<`string`\>
diff --git a/implementations/apollo-server/README.md b/implementations/apollo-server/README.md