Skip to content

Commit da32059

Browse files
feat(audits/render): Render audit results to HTML with renderAuditResultsToHTML (#53)
Co-authored-by: github-actions[bot] <41898282+github-actions[bot]@users.noreply.github.com>
1 parent 3d9f67d commit da32059

File tree

19 files changed

+7455
-7879
lines changed

19 files changed

+7455
-7879
lines changed

docs/README.md

+1
Original file line numberDiff line numberDiff line change
@@ -7,6 +7,7 @@ graphql-http
77
### Modules
88

99
- [audits/common](modules/audits_common.md)
10+
- [audits/render](modules/audits_render.md)
1011
- [audits/server](modules/audits_server.md)
1112
- [client](modules/client.md)
1213
- [common](modules/common.md)

docs/modules/audits_render.md

+30
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
[graphql-http](../README.md) / audits/render
2+
3+
# Module: audits/render
4+
5+
## Table of contents
6+
7+
### Functions
8+
9+
- [renderAuditResultsToHTML](audits_render.md#renderauditresultstohtml)
10+
11+
## Functions
12+
13+
### renderAuditResultsToHTML
14+
15+
**renderAuditResultsToHTML**(`results`): `Promise`<`string`\>
16+
17+
Renders the provided audit results to well-formatted and valid HTML.
18+
19+
Do note that the rendered result is not an HTML document, it's rather
20+
just a component with results.
21+
22+
#### Parameters
23+
24+
| Name | Type |
25+
| :------ | :------ |
26+
| `results` | [`AuditResult`](audits_common.md#auditresult)[] |
27+
28+
#### Returns
29+
30+
`Promise`<`string`\>

implementations/apollo-server/README.md

+964-1,034
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)