← All rules

API ContractsAPI contracts

api-contracts/no-ignored-significant-results

Use results whose visible contracts communicate success, validation, or partial failure instead of invoking the call only for its side effects.

return-valuesvalidationfailures

01 Examples

TypeScript

validateOrder(order); submit(order);

Finding

Do not discard meaningful call results.

02 Enable it

Setup

Install the package, register its plugin factory, then enable the rule.

Install the package

pnpm add -D @scruple/api-contracts

Register the plugin

In scruple.config.ts, register the factory under the api-contracts namespace used by the rule ID.

import { apiContracts } from "@scruple/api-contracts";

plugins: {
  "api-contracts": apiContracts(),
},

Enable the rule

"api-contracts/no-ignored-significant-results": "warn"

Package

@scruple/api-contracts

Default threshold

Plugin default

Minimum confidence

Plugin default