Class Organisational

The Organisational pseudo-component add organisation based author data to and contributors the project.

Hierarchy

PseudoComponent<NodeProject>
- Organisational

Index

Constructors

constructor

Properties

options

Methods

Constructors

constructor

new Organisational(options: OrganisationalOptions): Organisational

Overrides PseudoComponent.constructor

creates the organisational pseudo-component

Parameters
- options: OrganisationalOptions
  
  the organisation and contributors
Returns Organisational

Properties

options

options: Required<OrganisationalOptions>

Methods

addToProject

addToProject(project: NodeProject): void

Inherited from PseudoComponent.addToProject

adds the pseudo-component to the project

Parameters
- project: NodeProject
  
  the project to apply to
Returns void

jsiiProjectOptions

jsiiProjectOptions(): Pick<NodeProjectOptions, "authorName" | "authorEmail" | "authorOrganization"> & Pick<JsiiProjectOptions, "author" | "authorAddress">

returns the organisation related options that can then be passed into a NodeProject's constructor

Returns Pick<NodeProjectOptions, "authorName" | "authorEmail" | "authorOrganization"> & Pick<JsiiProjectOptions, "author" | "authorAddress">
the options

nodeProjectOptions

nodeProjectOptions(): Pick<NodeProjectOptions, "authorName" | "authorEmail" | "authorUrl" | "authorOrganization">

returns the organisation related options that can then be passed into a NodeProject's constructor

Returns Pick<NodeProjectOptions, "authorName" | "authorEmail" | "authorUrl" | "authorOrganization">
the options

postAddToProject

postAddToProject(_project: NodeProject): void

Inherited from PseudoComponent.postAddToProject

called after the pseudo-component is added to the project

Parameters
- _project: NodeProject
  
  the project to apply to
Returns void

postSynthesize

postSynthesize(_project: NodeProject): void

Inherited from PseudoComponent.postSynthesize

Called after synthesis. Order is not guaranteed.

Parameters
- _project: NodeProject
  
  the project to apply to
Returns void

preSynthesize

preSynthesize(_project: NodeProject): void

Inherited from PseudoComponent.preSynthesize

Called before synthesis.

Parameters
- _project: NodeProject
  
  the project to apply to
Returns void

synthesize

synthesize(_project: NodeProject): void

Inherited from PseudoComponent.synthesize

Synthesizes files to the project output directory.

Parameters
- _project: NodeProject
  
  the project to apply to
Returns void

Generated using TypeDoc