@duckduckgo/content-scope-scripts
    Preparing search index...

    The wire shape of a successful action result. response is action-specific (e.g. { url } for navigate, an array of matched profiles for extract).

    interface SuccessResponse {
        success: {
            actionID: string;
            actionType: string;
            meta?: { [k: string]: unknown };
            next?: PirAction[];
            response: { [k: string]: unknown };
        };
    }
    Index

    Properties

    Properties

    success: {
        actionID: string;
        actionType: string;
        meta?: { [k: string]: unknown };
        next?: PirAction[];
        response: { [k: string]: unknown };
    }

    Type Declaration

    • actionID: string
    • actionType: string
    • Optionalmeta?: { [k: string]: unknown }

      optional action-specific metadata attached to the result (e.g. extract attaches the { userData } it matched against)

    • Optionalnext?: PirAction[]

      follow-up actions the executor runs locally after this one (e.g. produced by an expectation action); each is executed with the same data and reports its own result

    • response: { [k: string]: unknown }

      action-specific result payload