Function genIndex

Parameters

• config: {
      exclude?:
          | readonly string[]
          | (
              (
                  args: Readonly<
                      { absolutePath: string; fileName: string; relativePath: string },
                  >,
              ) => boolean
          );
      exportStatementExtension?: `.${string}` | "none";
      formatCommand?: string;
      indexFileExtension?: `.${string}`;
      silent?: boolean;
      targetDirectory: string | readonly string[];
      targetExtensions?: readonly `.${string}`[];
  }

  Configuration for index file generation

  • Optional Readonlyexclude?:
        | readonly string[]
        | (
            (
                args: Readonly<
                    { absolutePath: string; fileName: string; relativePath: string },
                >,
            ) => boolean
        )

    Glob patterns of files or predicate function to exclude from exports (default: excludes '**/*.{test,spec}.?(c|m)[jt]s?(x)' and '**/*.d.?(c|m)ts')

  • Optional ReadonlyexportStatementExtension?: `.${string}` | "none"

    File extension to use in export statements (default: '.js')

  • Optional ReadonlyformatCommand?: string

    Command to run for formatting generated files (optional)

  • Optional ReadonlyindexFileExtension?: `.${string}`

    File extension of index files to generate (default: '.ts')

  • Optional Readonlysilent?: boolean

    Whether to suppress output during execution (default: false)

  • ReadonlytargetDirectory: string | readonly string[]

    Target directories to generate index files for (string or array of strings)

  • Optional ReadonlytargetExtensions?: readonly `.${string}`[]

    File extensions of source files to export (default: ['.ts', '.tsx'])