Skip to content

feat(audits/render): Render audit results to HTML with renderAuditResultsToHTML #53

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 6 commits into from
Feb 12, 2023
Merged

feat(audits/render): Render audit results to HTML with renderAuditResultsToHTML #53

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
6de8d88
begin
enisdenjo Feb 12, 2023
6d66cf0
docs
enisdenjo Feb 12, 2023
c7b40d9
tests
enisdenjo Feb 12, 2023
eb4b791
script uses render to html
enisdenjo Feb 12, 2023
309bf6f
docs(implementations): audit report [skip ci]
github-actions[bot] Feb 12, 2023
934aa6c
unnecessary type imports
enisdenjo Feb 12, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 1 addition & 0 deletions docs/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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)
Expand Down
30 changes: 30 additions & 0 deletions docs/modules/audits_render.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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`\>
1,998 changes: 964 additions & 1,034 deletions implementations/apollo-server/README.md
View file
Open in desktop

Large diffs are not rendered by default.

Loading