audits_common.Audit.md

graphql-http / audits/common / Audit

Interface: Audit

audits/common.Audit

Actual audit test returning an result.

The test function will throw only if the error is fatal.

Table of contents

Properties

• fn
• id
• name

Properties

fn

• fn: () => Promise<AuditResult>

Type declaration

▸ (): Promise<AuditResult>

Returns

Promise<AuditResult>

---

id

• id: string

Uniquely represents the audit. Helps with pinning audits without depending on the human readable audit name.

---

name

• name: `MUST ${string}` | `SHOULD ${string}` | `MAY ${string}`