Documentation for Simbo's Packages
    Preparing search index...
    • A helper function to define the configuration object with proper types.

      Parameters

      • config:
            | {
                after?: string
                | BeforeAfterFn;
                before?: string | BeforeAfterFn;
                delimiter?: string;
                filterFn?: FilterFn;
                sortCompareFn?: SortCompareFn;
                targetFile?: string;
                templateData?: {
                    changelogUrlFn?: TemplateDataFn;
                    docsUrlFn?: TemplateDataFn;
                    packageUrlFn?: TemplateDataFn;
                    readmeUrlFn?: TemplateDataFn;
                    repoUrlFn?: TemplateDataFn;
                    [key: string]: unknown;
                };
                templateFn?: TemplateFn;
            }
            | {
                after?: string
                | BeforeAfterFn;
                before?: string | BeforeAfterFn;
                delimiter?: string;
                filterFn?: FilterFn;
                sortCompareFn?: SortCompareFn;
                targetFile?: string;
                templateData?: {
                    changelogUrlFn?: TemplateDataFn;
                    docsUrlFn?: TemplateDataFn;
                    packageUrlFn?: TemplateDataFn;
                    readmeUrlFn?: TemplateDataFn;
                    repoUrlFn?: TemplateDataFn;
                    [key: string]: unknown;
                };
                templateFn?: TemplateFn;
            }[]

        The configuration object or array of objects to define.

      Returns
          | {
              after?: string
              | BeforeAfterFn;
              before?: string | BeforeAfterFn;
              delimiter?: string;
              filterFn?: FilterFn;
              sortCompareFn?: SortCompareFn;
              targetFile?: string;
              templateData?: {
                  changelogUrlFn?: TemplateDataFn;
                  docsUrlFn?: TemplateDataFn;
                  packageUrlFn?: TemplateDataFn;
                  readmeUrlFn?: TemplateDataFn;
                  repoUrlFn?: TemplateDataFn;
                  [key: string]: unknown;
              };
              templateFn?: TemplateFn;
          }
          | {
              after?: string
              | BeforeAfterFn;
              before?: string | BeforeAfterFn;
              delimiter?: string;
              filterFn?: FilterFn;
              sortCompareFn?: SortCompareFn;
              targetFile?: string;
              templateData?: {
                  changelogUrlFn?: TemplateDataFn;
                  docsUrlFn?: TemplateDataFn;
                  packageUrlFn?: TemplateDataFn;
                  readmeUrlFn?: TemplateDataFn;
                  repoUrlFn?: TemplateDataFn;
                  [key: string]: unknown;
              };
              templateFn?: TemplateFn;
          }[]

      The defined configuration object or array of objects.