Interface Rule

meta

check

• check(
      data: {
          symbol: string;
          exchange?: string;
          currency?: string;
          source: string;
          identifiers?: { isin?: string; cusip?: string; figi?: string };
          bars: {
              timestamp: string;
              open: number;
              high: number;
              low: number;
              close: number;
              volume?: number;
              adjustmentFactor?: number;
          }[];
          dividends?: {
              exDate: string;
              payDate?: string;
              amount: number;
              currency?: string;
              type?: "regular"
              | "special";
          }[];
          splits?: { exDate: string; numerator: number; denominator: number }[];
          fundamentals?: {
              marketCap?: number;
              sharesOutstanding?: number;
              eps?: number;
              pe?: number;
              dividendYield?: number;
              payoutRatio?: number;
          };
      },
      context: RuleContext,
  ): Finding[]

  Returns one finding per occurrence. The engine collapses them into a single report entry with occurrences — rules should NOT self-collapse.

  Findings normally carry context.config.severity. A rule MAY deliberately emit a lower severity for a lighter sub-case (e.g. CURRENCY_SUSPECT degrades "currency absent" to info): the engine preserves that choice unless the user overrides the rule's severity in the config.

  Parameters

  • data: {
        symbol: string;
        exchange?: string;
        currency?: string;
        source: string;
        identifiers?: { isin?: string; cusip?: string; figi?: string };
        bars: {
            timestamp: string;
            open: number;
            high: number;
            low: number;
            close: number;
            volume?: number;
            adjustmentFactor?: number;
        }[];
        dividends?: {
            exDate: string;
            payDate?: string;
            amount: number;
            currency?: string;
            type?: "regular"
            | "special";
        }[];
        splits?: { exDate: string; numerator: number; denominator: number }[];
        fundamentals?: {
            marketCap?: number;
            sharesOutstanding?: number;
            eps?: number;
            pe?: number;
            dividendYield?: number;
            payoutRatio?: number;
        };
    }

    • symbol: string

    • Optionalexchange?: string

    • Optionalcurrency?: string

    • source: string

      Provenance is mandatory: a report must always be able to say where each datum came from.

    • Optionalidentifiers?: { isin?: string; cusip?: string; figi?: string }

    • bars: {
          timestamp: string;
          open: number;
          high: number;
          low: number;
          close: number;
          volume?: number;
          adjustmentFactor?: number;
      }[]

    • Optionaldividends?: {
          exDate: string;
          payDate?: string;
          amount: number;
          currency?: string;
          type?: "regular" | "special";
      }[]

    • Optionalsplits?: { exDate: string; numerator: number; denominator: number }[]

    • Optionalfundamentals?: {
          marketCap?: number;
          sharesOutstanding?: number;
          eps?: number;
          pe?: number;
          dividendYield?: number;
          payoutRatio?: number;
      }

  • context: RuleContext

  Returns Finding[]