Documentation for Simbo's Packages
    Preparing search index...

    Interface TemplateData

    Data to use in the template function.

    interface TemplateData {
        changelogUrlFn?: TemplateDataFn;
        docsUrlFn?: TemplateDataFn;
        packageUrlFn?: TemplateDataFn;
        readmeUrlFn?: TemplateDataFn;
        repoUrlFn?: TemplateDataFn;
        [key: string]: unknown;
    }

    Indexable

    • [key: string]: unknown

      Allows additional template data to be passed to the template function.

    Index

    Properties

    changelogUrlFn? docsUrlFn? packageUrlFn? readmeUrlFn? repoUrlFn?

    Properties

    changelogUrlFn?: TemplateDataFn

    A function that receives the workspace metadata and returns the URL to the package changelog. (e.g. https://github.com/user/repo/blob/main/packages/my-package/CHANGELOG.md)

    docsUrlFn?: TemplateDataFn

    A function that receives the workspace metadata and returns the URL to the package documentation. (e.g. https://user.github.io/repo/modules/_scope_my-package)

    packageUrlFn?: TemplateDataFn

    A function that receives the workspace metadata and returns the URL to the package in the package registry. (e.g. https://www.npmjs.com/package/@scope/my-package)

    readmeUrlFn?: TemplateDataFn

    A function that receives the workspace metadata and returns the URL to the package README. (e.g. https://github.com/user/repo/blob/main/packages/my-package/README.md)

    repoUrlFn?: TemplateDataFn

    A function that receives the workspace metadata and returns the URL package in its the repository. (e.g. https://github.com/user/repo/tree/main/packages/my-package/)

    Settings

    Member Visibility

    On This Page

    Properties