SHARDWIRE
ReferenceContracts & Diagnostics

ShardwireAppDiagnosisReport

Reference for `ShardwireAppDiagnosisReport`, exported as part of the public Shardwire surface.

interface exported from src/discord/types.ts.

Summary

Reference for ShardwireAppDiagnosisReport, exported as part of the public Shardwire surface.

Signature

export interface ShardwireAppDiagnosisReport {
	/**
	 * `true` iff **no** issue has `severity: 'error'` — same gate as strict startup (`app.ready({ strict: true })`).
	 * Warnings (for example `unused_negotiated_*`), unused negotiated capabilities, and any other non-error issues
	 * never set this to `false`.
	 */
	ok: boolean;
	issues: ShardwireAppDiagnosisIssue[];
	/** Union of gateway intents required by manifest `events` (from the static catalog). */
	requiredIntents: readonly BotIntentName[];
	/** Same shape as {@link generateSecretScope}. */
	minimumScope: SecretPermissions;
}

Structure

ShardwireAppDiagnosisIssueCode

Machine-readable issue codes from diagnoseShardwireApp. **Filter semantics (no “suspicious” heuristics):** - **`unsupported_filter_key`** — not a built-in key from `app.catalog().subscriptionFilters`. - **`filter_key_absent_from_event_metadata`** — key is built-in, but the bridge’s subscription matcher never supplies it for this event name, so a filter on it **cannot** match any payload (structural impossibility). Narrow filters that merely match rarely (e.g. a specific `guildId`) are **not** flagged.

ShardwireAppDiagnosisSeverity

Reference for `ShardwireAppDiagnosisSeverity`, exported as part of the public Shardwire surface.

On this page

SummarySignatureStructureRelated Guides