View on GitHub

@ncfour-us/projen-utils Projen contstructs

Useful constructs for building TypeScript projects managed through projen

Download this project as a .zip file Download this project as a tar.gz file

@ncfour-us/projen-utils / sampleReadmeProps

Function: sampleReadmeProps()

sampleReadmeProps(options?): SampleReadmeProps

This function is used to pass the result of creating this Construct to another project’s constructor.

For projects which have a readme option in their constructor, use this function as follows:

  ...
  readme: sampleReadmeProps(...),
  ...

Parameters

options?

ReadmeSampleFileOptions

ReadmeSampleFileOptions to be used in adjusting the README file

Returns

SampleReadmeProps

SampleReadmeProps to be used in a Project constructor