Open Cap Table Protocol Canton SDK - v0.2.224
    Preparing search index...

    Function validateDeprecatedFields

    • Validate an object for deprecated field usage.

      This is useful for validation pipelines where you want to:

      • Warn users about deprecated field usage
      • Optionally fail validation on deprecated fields
      • Generate clear validation messages

      Parameters

      • objectType: string

        The OCF object type

      • data: Record<string, unknown>

        The data to validate

      • options: DeprecationValidationOptions = {}

        Validation options

      Returns DeprecationValidationResult

      Validation result

        const result = validateDeprecatedFields('StockPlan', {
      stock_class_id: 'sc-1',
      }, { treatAsError: false });

      if (!result.valid) {
      console.error(result.errors.join('\n'));
      } else if (result.warnings.length > 0) {
      console.warn(result.warnings.join('\n'));
      }