Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Contributors

The Contributors component adds contributor information to the project

Hierarchy

  • Component
    • Contributors

Index

Constructors

Properties

Methods

Constructors

constructor

  • creates the contributors component

    Parameters

    • project: NodeProject

      the project to add to

    • Optional options: Dynamic<ContributorsOptions, NodeProject>

      options

    Returns Contributors

Properties

contributors

contributors: Set<string | Entity>

nodeProject

nodeProject: NodeProject

options

options: DeepRequired<ContributorsOptions>

Readonly project

project: Project

Static defaultOptions

defaultOptions: DeepRequired<ContributorsOptions> = ...

Methods

addContributors

  • addContributors(...contributors: (string | Entity)[]): void

  • adds contributors to the project

    Parameters

    • Rest ...contributors: (string | Entity)[]

      the contributors to add

    Returns void

postSynthesize

  • postSynthesize(): void

  • Called after synthesis. Order is not guaranteed.

    Returns void

preSynthesize

  • preSynthesize(): void

  • adds the contributors to the package.json file.

    Returns void

synthesize

  • synthesize(): void

  • Synthesizes files to the project output directory.

    Returns void

Generated using TypeDoc