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

    Interface DeprecationReport

    Detailed deprecation report for analysis and documentation.

    interface DeprecationReport {
        affectedItems?: {
            deprecatedFieldsUsed: string[];
            itemId: string;
            objectType: string;
        }[];
        byField: Record<
            string,
            {
                deprecationType: string;
                objectTypesAffected: string[];
                replacementField: string;
                totalUsages: number;
            },
        >;
        byObjectType: Record<
            string,
            {
                deprecationPercentage: number;
                fieldsUsed: Record<string, number>;
                total: number;
                withDeprecatedFields: number;
            },
        >;
        generatedAt: string;
        summary: {
            deprecationPercentage: number;
            objectsWithDeprecatedFields: number;
            totalDeprecatedFieldUsages: number;
            totalObjects: number;
        };
    }
    Index

    Properties

    affectedItems? byField byObjectType generatedAt summary

    Properties

    affectedItems?: {
        deprecatedFieldsUsed: string[];
        itemId: string;
        objectType: string;
    }[]

    List of all affected items (optional, for detailed reports)

    byField: Record<
        string,
        {
            deprecationType: string;
            objectTypesAffected: string[];
            replacementField: string;
            totalUsages: number;
        },
    >

    Breakdown by deprecated field

    byObjectType: Record<
        string,
        {
            deprecationPercentage: number;
            fieldsUsed: Record<string, number>;
            total: number;
            withDeprecatedFields: number;
        },
    >

    Breakdown by object type

    generatedAt: string

    Timestamp when the report was generated

    summary: {
        deprecationPercentage: number;
        objectsWithDeprecatedFields: number;
        totalDeprecatedFieldUsages: number;
        totalObjects: number;
    }

    Summary statistics

    Type Declaration

    • deprecationPercentage: number

      Percentage of objects with deprecated fields

    • objectsWithDeprecatedFields: number

      Objects with deprecated fields

    • totalDeprecatedFieldUsages: number

      Total deprecated field usages

    • totalObjects: number

      Total objects analyzed

    Settings

    Member Visibility

    On This Page

    Properties