Skip to content

Type Alias: SchemaMismatchBehavior ​

ts
type SchemaMismatchBehavior = "warn" | "silent" | "throw" | ((report) => void);

Defined in: src/core/schemaMismatch.ts:49

What to do when a response does not match its schema.

  • 'warn' (default) — report once per distinct problem and hand back the body unvalidated.
  • 'silent' — hand back the body unvalidated, say nothing.
  • 'throw' — raise SchemaMismatchError.
  • A function — receives the report and replaces the printing entirely.

The default is not 'throw' on purpose. Jira's responses vary with things the library cannot see — a tenant's locale, whether a feature is on, team-managed versus company-managed projects, an enum Atlassian grew on a Thursday. None of those are the caller's bug, and none should take down their integration. Set 'throw' in a test suite, where a mismatch is the thing under test.