@hrefcl/apidoc - v4.0.5
    Preparing search index...

    Function preProcess

    Export configuration for the group worker

    • Api Define

      PreProcess API Group tags to collect group definitions

      First phase of group processing that scans parsed files to collect blocks that define group metadata (titles and descriptions). These definitions will be used later to enhance group information in API endpoints.

      Parameters

      • parsedFiles: any

        Array of parsed file objects containing group definitions

      • filenames: any

        Array of filenames for the parsed files

      • packageInfos: any

        Package information for version handling

      • target: any

        Target key in result object for storing group definitions

      Returns {}

      Object containing group definitions organized by name and version

      // Collects @apiDefine blocks for groups
      const result = preProcess(parsedFiles, filenames, packageInfos, 'defineGroup');
      // Returns: { defineGroup: { "User": { "1.0.0": { title: "User Management", description: "..." } } } }

      4.0.0

    Settings

    Member Visibility