API Reference

Classes

Name	Description
CdkPipelineAspect	No description
PrivateTaimosCdkApp	Private AWS CDK app in TypeScript.
SopsAspect	No description
TaimosCdkApp	AWS CDK app in TypeScript.
TaimosCdkConstructLibrary	TypeScript library.
TaimosPrivateTypescriptLibrary	Private TypeScript library.
TaimosTypescriptLibrary	TypeScript library.

Structs

Name	Description
PrivateTaimosCdkAppOptions	No description
SopsAspectOptions	No description
TaimosCdkAppOptions	No description
TaimosCdkConstructLibraryOptions	No description
TaimosPrivateTypescriptLibraryOptions	No description
TaimosTypescriptLibraryOptions	No description

class CdkPipelineAspect

Extends: Component

Initializer

new CdkPipelineAspect(app: TaimosCdkApp)

app (TaimosCdkApp) No description

class PrivateTaimosCdkApp

Private AWS CDK app in TypeScript.

Extends: TaimosCdkApp

Initializer

new PrivateTaimosCdkApp(options: PrivateTaimosCdkAppOptions)

options (PrivateTaimosCdkAppOptions) No description
- name (string) This is the name of your project.
- logging (LoggerOptions) Configure logging options such as verbosity. Default: {}
- outdir (string) The root directory of the project. Default: "."
- parent (Project) The parent project, if this project is part of a bigger project. Optional
- projenCommand (string) The shell command to use in order to run the projen CLI. Default: "npx projen"
- projenrcJson (boolean) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. Default: false
- projenrcJsonOptions (ProjenrcOptions) Options for .projenrc.json. Default: default options
- autoApproveOptions (github.AutoApproveOptions) Enable and configure the 'auto approve' workflow. Default: auto approve is disabled
- autoMerge (boolean) Enable automatic merging on GitHub. Default: true
- autoMergeOptions (github.AutoMergeOptions) Configure options for automatic merging on GitHub. Default: see defaults in AutoMergeOptions
- clobber (boolean) Add a clobber task which resets the repo to origin. Default: true
- devContainer (boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false
- github (boolean) Enable GitHub integration. Default: true
- githubOptions (github.GitHubOptions) Options for GitHub integration. Default: see GitHubOptions
- gitpod (boolean) Add a Gitpod development environment. Default: false
- mergify (boolean) Whether mergify should be enabled on this repository or not. Default: true
- mergifyOptions (github.MergifyOptions) Options for mergify. Default: default options
- projectType (ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
- projenCredentials (github.GithubCredentials) Choose a method of providing GitHub API access for projen workflows. Default: use a personal access token named PROJEN_GITHUB_TOKEN
- projenTokenSecret (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. Default: "PROJEN_GITHUB_TOKEN"
- readme (SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' }
- stale (boolean) Auto-close of stale issues and pull request. Default: false
- staleOptions (github.StaleOptions) Auto-close stale issues and pull requests. Default: see defaults in StaleOptions
- vscode (boolean) Enable VSCode integration. Default: true
- allowLibraryDependencies (boolean) Allow the project to include peerDependencies and bundledDependencies. Default: true
- authorEmail (string) Author's e-mail. Optional
- authorName (string) Author's name. Optional
- authorOrganization (boolean) Author's Organization. Optional
- authorUrl (string) Author's URL / Website. Optional
- autoDetectBin (boolean) Automatically add all executables under the bin directory to your package.json file under the bin section. Default: true
- bin (Map<string, string>) Binary programs vended with your module. Optional
- bugsEmail (string) The email address to which issues should be reported. Optional
- bugsUrl (string) The url to your project's issue tracker. Optional
- bundledDeps (Array) List of dependencies to bundle into this module. Optional
- codeArtifactOptions (javascript.CodeArtifactOptions) Options for npm packages using AWS CodeArtifact. Default: undefined
- deps (Array) Runtime dependencies of this module. Default: []
- description (string) The description is just a string that helps people understand the purpose of the package. Optional
- devDeps (Array) Build dependencies for this module. Default: []
- entrypoint (string) Module entrypoint (main in package.json). Default: "lib/index.js"
- homepage (string) Package's Homepage / Website. Optional
- keywords (Array) Keywords to include in package.json. Optional
- license (string) License's SPDX identifier. Default: "Apache-2.0"
- licensed (boolean) Indicates if a license should be added. Default: true
- maxNodeVersion (string) Minimum node.js version to require via engines (inclusive). Default: no max
- minNodeVersion (string) Minimum Node.js version to require via package.json engines (inclusive). Default: no "engines" specified
- npmAccess (javascript.NpmAccess) Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
- npmRegistry (string) The host name of the npm registry to publish to. Optional
- npmRegistryUrl (string) The base URL of the npm package registry. Default: "https://registry.npmjs.org"
- npmTokenSecret (string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
- packageManager (javascript.NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN
- packageName (string) The "name" in package.json. Default: defaults to project name
- peerDependencyOptions (javascript.PeerDependencyOptions) Options for peerDeps. Optional
- peerDeps (Array) Peer dependencies for this module. Default: []
- repository (string) The repository is the location where the actual code for your package lives. Optional
- repositoryDirectory (string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional
- scopedPackagesOptions (Array<javascript.ScopedPackagesOptions>) Options for privately hosted scoped packages. Default: fetch all scoped packages from the public npm registry
- scripts (Map<string, string>) npm scripts to include. Default: {}
- stability (string) Package's Stability. Optional
- jsiiReleaseVersion (string) Version requirement of publib which is used to publish modules to npm. Default: "latest"
- majorVersion (number) Major version to release from the default branch. Default: Major version is not enforced.
- npmDistTag (string) The npmDistTag to use when publishing from the default branch. Default: "latest"
- postBuildSteps (Array<github.workflows.JobStep>) Steps to execute after build as part of the release workflow. Default: []
- prerelease (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: normal semantic versions
- publishDryRun (boolean) Instead of actually publishing to package managers, just print the publishing command. Default: false
- publishTasks (boolean) Define publishing tasks that can be executed manually as well as workflows. Default: false
- releaseBranches (Map<string, release.BranchOptions>) Defines additional release branches. Default: no additional branches are used for release. you can use addBranch() to add additional branches.
- releaseEveryCommit (boolean) Automatically release new versions every commit to one of branches in releaseBranches. Default: true
- releaseFailureIssue (boolean) Create a github issue on every failed publishing task. Default: false
- releaseFailureIssueLabel (string) The label to apply to issues indicating publish failures. Default: "failed-release"
- releaseSchedule (string) CRON schedule to trigger new releases. Default: no scheduled releases
- releaseTagPrefix (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Default: no prefix
- releaseTrigger (release.ReleaseTrigger) The release trigger to use. Default: Continuous releases (ReleaseTrigger.continuous())
- releaseWorkflowName (string) The name of the default release workflow. Default: "Release"
- releaseWorkflowSetupSteps (Array<github.workflows.JobStep>) A set of workflow steps to execute in order to setup the workflow container. Optional
- versionrcOptions (Map<string, any>) Custom configuration used when creating changelog with standard-version package. Default: standard configuration applicable for GitHub repositories
- workflowContainerImage (string) Container image to use for GitHub workflows. Default: default image
- workflowRunsOn (Array) Github Runner selection labels. Default: ["ubuntu-latest"]
- defaultReleaseBranch (string) The name of the main release branch.
- artifactsDirectory (string) A directory which will contain build artifacts. Default: "dist"
- autoApproveUpgrades (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Default: true
- buildWorkflow (boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject
- buildWorkflowTriggers (github.workflows.Triggers) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
- bundlerOptions (javascript.BundlerOptions) Options for Bundler. Optional
- codeCov (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false
- codeCovTokenSecret (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported
- copyrightOwner (string) License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined.
- copyrightPeriod (string) The copyright years to put in the LICENSE file. Default: current year
- dependabot (boolean) Use dependabot to handle dependency upgrades. Default: false
- dependabotOptions (github.DependabotOptions) Options for dependabot. Default: default options
- depsUpgrade (boolean) Use github workflows to handle dependency upgrades. Default: true
- depsUpgradeOptions (javascript.UpgradeDependenciesOptions) Options for UpgradeDependencies. Default: default options
- gitignore (Array) Additional entries to .gitignore. Optional
- jest (boolean) Setup jest unit tests. Default: true
- jestOptions (javascript.JestOptions) Jest options. Default: default options
- mutableBuild (boolean) Automatically update files modified during builds to pull-request branches. Default: true
- npmignore (Array) Additional entries to .npmignore. Optional
- npmignoreEnabled (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
- package (boolean) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). Default: true
- prettier (boolean) Setup prettier. Default: false
- prettierOptions (javascript.PrettierOptions) Prettier options. Default: default options
- projenDevDependency (boolean) Indicates of "projen" should be installed as a devDependency. Default: true
- projenrcJs (boolean) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. Default: true if projenrcJson is false
- projenrcJsOptions (javascript.ProjenrcOptions) Options for .projenrc.js. Default: default options
- projenVersion (string) Version of projen to install. Default: Defaults to the latest version.
- pullRequestTemplate (boolean) Include a GitHub pull request template. Default: true
- pullRequestTemplateContents (Array) The contents of the pull request template. Default: default content
- release (boolean) Add release management to this project. Default: true (false for subprojects)
- releaseToNpm (boolean) Automatically release to npm when new versions are introduced. Default: false
- releaseWorkflow (boolean) DEPRECATED: renamed to release. Default: true if not a subproject
- workflowBootstrapSteps (Array<github.workflows.JobStep>) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
- workflowGitIdentity (github.GitIdentity) The git identity to use in workflows. Default: GitHub Actions
- workflowNodeVersion (string) The node version to use in GitHub workflows. Default: same as minNodeVersion
- disableTsconfig (boolean) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
- docgen (boolean) Docgen by Typedoc. Default: false
- docsDirectory (string) Docs directory. Default: "docs"
- entrypointTypes (string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
- eslint (boolean) Setup eslint. Default: true
- eslintOptions (javascript.EslintOptions) Eslint options. Default: opinionated default options
- libdir (string) Typescript artifacts output directory. Default: "lib"
- projenrcTs (boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false
- projenrcTsOptions (typescript.ProjenrcOptions) Options for .projenrc.ts. Optional
- sampleCode (boolean) Generate one-time sample in src/ and test/ if there are no files there. Default: true
- srcdir (string) Typescript sources directory. Default: "src"
- testdir (string) Jest tests directory. Tests files should be named xxx.test.ts. Default: "test"
- tsconfig (javascript.TypescriptConfigOptions) Custom TSConfig. Default: default options
- tsconfigDev (javascript.TypescriptConfigOptions) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: use the production tsconfig options
- tsconfigDevFile (string) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
- typescriptVersion (string) TypeScript version to use. Default: "latest"
- buildCommand (string) A command to execute before synthesis. Default: no build command
- cdkout (string) cdk.out directory. Default: "cdk.out"
- context (Map<string, any>) Additional context to include in cdk.json. Default: no additional context
- featureFlags (boolean) Include all feature flags in cdk.json. Default: true
- requireApproval (awscdk.ApprovalLevel) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: ApprovalLevel.BROADENING
- watchExcludes (Array) Glob patterns to exclude from cdk watch. Default: []
- watchIncludes (Array) Glob patterns to include in cdk watch. Default: []
- cdkVersion (string) Minimum version of the AWS CDK to depend on.
- cdkAssert (boolean) Warning: NodeJS only. Default: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
- cdkAssertions (boolean) Install the assertions library? Default: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
- cdkDependencies (Array) Which AWS CDKv1 modules this project requires. Optional
- cdkDependenciesAsDeps (boolean) If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies). Default: true
- cdkTestDependencies (Array) AWS CDK modules required for testing. Optional
- cdkVersionPinning (boolean) Use pinned version instead of caret version for CDK. Optional
- constructsVersion (string) Minimum version of the constructs library to depend on. Default: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
- appEntrypoint (string) The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts"
- integrationTestAutoDiscover (boolean) Automatically discovers and creates integration tests for each .integ.ts file in under your test directory. Default: true
- lambdaAutoDiscover (boolean) Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project. Default: true
- lambdaExtensionAutoDiscover (boolean) Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project. Default: true
- lambdaOptions (awscdk.LambdaFunctionCommonOptions) Common options for all AWS Lambda functions. Default: default options
- cdkPipelines (boolean) Enable CDK pipelines. Default: false
- sops (SopsAspectOptions) Enable storing secrets using Mozilla SOPS. Default: no SOPS config

Properties

Name	Type	Description
npmConfig	`javascript.NpmConfig`

class SopsAspect

Extends: Component

Initializer

new SopsAspect(app: TypeScriptProject, options: SopsAspectOptions)

app (typescript.TypeScriptProject) No description
options (SopsAspectOptions) No description
- secrets (Map<string, string>) Define a mapping of SOPS files to SecretsManager secrets.

Properties

Name	Type	Description
generatedCodeFile	`SourceCode`

class TaimosCdkApp

AWS CDK app in TypeScript.

Extends: awscdk.AwsCdkTypeScriptApp

Initializer

new TaimosCdkApp(options: TaimosCdkAppOptions)

options (TaimosCdkAppOptions) No description
- name (string) This is the name of your project.
- logging (LoggerOptions) Configure logging options such as verbosity. Default: {}
- outdir (string) The root directory of the project. Default: "."
- parent (Project) The parent project, if this project is part of a bigger project. Optional
- projenCommand (string) The shell command to use in order to run the projen CLI. Default: "npx projen"
- projenrcJson (boolean) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. Default: false
- projenrcJsonOptions (ProjenrcOptions) Options for .projenrc.json. Default: default options
- autoApproveOptions (github.AutoApproveOptions) Enable and configure the 'auto approve' workflow. Default: auto approve is disabled
- autoMerge (boolean) Enable automatic merging on GitHub. Default: true
- autoMergeOptions (github.AutoMergeOptions) Configure options for automatic merging on GitHub. Default: see defaults in AutoMergeOptions
- clobber (boolean) Add a clobber task which resets the repo to origin. Default: true
- devContainer (boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false
- github (boolean) Enable GitHub integration. Default: true
- githubOptions (github.GitHubOptions) Options for GitHub integration. Default: see GitHubOptions
- gitpod (boolean) Add a Gitpod development environment. Default: false
- mergify (boolean) Whether mergify should be enabled on this repository or not. Default: true
- mergifyOptions (github.MergifyOptions) Options for mergify. Default: default options
- projectType (ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
- projenCredentials (github.GithubCredentials) Choose a method of providing GitHub API access for projen workflows. Default: use a personal access token named PROJEN_GITHUB_TOKEN
- projenTokenSecret (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. Default: "PROJEN_GITHUB_TOKEN"
- readme (SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' }
- stale (boolean) Auto-close of stale issues and pull request. Default: false
- staleOptions (github.StaleOptions) Auto-close stale issues and pull requests. Default: see defaults in StaleOptions
- vscode (boolean) Enable VSCode integration. Default: true
- allowLibraryDependencies (boolean) Allow the project to include peerDependencies and bundledDependencies. Default: true
- authorEmail (string) Author's e-mail. Optional
- authorName (string) Author's name. Optional
- authorOrganization (boolean) Author's Organization. Optional
- authorUrl (string) Author's URL / Website. Optional
- autoDetectBin (boolean) Automatically add all executables under the bin directory to your package.json file under the bin section. Default: true
- bin (Map<string, string>) Binary programs vended with your module. Optional
- bugsEmail (string) The email address to which issues should be reported. Optional
- bugsUrl (string) The url to your project's issue tracker. Optional
- bundledDeps (Array) List of dependencies to bundle into this module. Optional
- codeArtifactOptions (javascript.CodeArtifactOptions) Options for npm packages using AWS CodeArtifact. Default: undefined
- deps (Array) Runtime dependencies of this module. Default: []
- description (string) The description is just a string that helps people understand the purpose of the package. Optional
- devDeps (Array) Build dependencies for this module. Default: []
- entrypoint (string) Module entrypoint (main in package.json). Default: "lib/index.js"
- homepage (string) Package's Homepage / Website. Optional
- keywords (Array) Keywords to include in package.json. Optional
- license (string) License's SPDX identifier. Default: "Apache-2.0"
- licensed (boolean) Indicates if a license should be added. Default: true
- maxNodeVersion (string) Minimum node.js version to require via engines (inclusive). Default: no max
- minNodeVersion (string) Minimum Node.js version to require via package.json engines (inclusive). Default: no "engines" specified
- npmAccess (javascript.NpmAccess) Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
- npmRegistry (string) The host name of the npm registry to publish to. Optional
- npmRegistryUrl (string) The base URL of the npm package registry. Default: "https://registry.npmjs.org"
- npmTokenSecret (string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
- packageManager (javascript.NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN
- packageName (string) The "name" in package.json. Default: defaults to project name
- peerDependencyOptions (javascript.PeerDependencyOptions) Options for peerDeps. Optional
- peerDeps (Array) Peer dependencies for this module. Default: []
- repository (string) The repository is the location where the actual code for your package lives. Optional
- repositoryDirectory (string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional
- scopedPackagesOptions (Array<javascript.ScopedPackagesOptions>) Options for privately hosted scoped packages. Default: fetch all scoped packages from the public npm registry
- scripts (Map<string, string>) npm scripts to include. Default: {}
- stability (string) Package's Stability. Optional
- jsiiReleaseVersion (string) Version requirement of publib which is used to publish modules to npm. Default: "latest"
- majorVersion (number) Major version to release from the default branch. Default: Major version is not enforced.
- npmDistTag (string) The npmDistTag to use when publishing from the default branch. Default: "latest"
- postBuildSteps (Array<github.workflows.JobStep>) Steps to execute after build as part of the release workflow. Default: []
- prerelease (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: normal semantic versions
- publishDryRun (boolean) Instead of actually publishing to package managers, just print the publishing command. Default: false
- publishTasks (boolean) Define publishing tasks that can be executed manually as well as workflows. Default: false
- releaseBranches (Map<string, release.BranchOptions>) Defines additional release branches. Default: no additional branches are used for release. you can use addBranch() to add additional branches.
- releaseEveryCommit (boolean) Automatically release new versions every commit to one of branches in releaseBranches. Default: true
- releaseFailureIssue (boolean) Create a github issue on every failed publishing task. Default: false
- releaseFailureIssueLabel (string) The label to apply to issues indicating publish failures. Default: "failed-release"
- releaseSchedule (string) CRON schedule to trigger new releases. Default: no scheduled releases
- releaseTagPrefix (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Default: no prefix
- releaseTrigger (release.ReleaseTrigger) The release trigger to use. Default: Continuous releases (ReleaseTrigger.continuous())
- releaseWorkflowName (string) The name of the default release workflow. Default: "Release"
- releaseWorkflowSetupSteps (Array<github.workflows.JobStep>) A set of workflow steps to execute in order to setup the workflow container. Optional
- versionrcOptions (Map<string, any>) Custom configuration used when creating changelog with standard-version package. Default: standard configuration applicable for GitHub repositories
- workflowContainerImage (string) Container image to use for GitHub workflows. Default: default image
- workflowRunsOn (Array) Github Runner selection labels. Default: ["ubuntu-latest"]
- defaultReleaseBranch (string) The name of the main release branch.
- artifactsDirectory (string) A directory which will contain build artifacts. Default: "dist"
- autoApproveUpgrades (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Default: true
- buildWorkflow (boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject
- buildWorkflowTriggers (github.workflows.Triggers) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
- bundlerOptions (javascript.BundlerOptions) Options for Bundler. Optional
- codeCov (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false
- codeCovTokenSecret (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported
- copyrightOwner (string) License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined.
- copyrightPeriod (string) The copyright years to put in the LICENSE file. Default: current year
- dependabot (boolean) Use dependabot to handle dependency upgrades. Default: false
- dependabotOptions (github.DependabotOptions) Options for dependabot. Default: default options
- depsUpgrade (boolean) Use github workflows to handle dependency upgrades. Default: true
- depsUpgradeOptions (javascript.UpgradeDependenciesOptions) Options for UpgradeDependencies. Default: default options
- gitignore (Array) Additional entries to .gitignore. Optional
- jest (boolean) Setup jest unit tests. Default: true
- jestOptions (javascript.JestOptions) Jest options. Default: default options
- mutableBuild (boolean) Automatically update files modified during builds to pull-request branches. Default: true
- npmignore (Array) Additional entries to .npmignore. Optional
- npmignoreEnabled (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
- package (boolean) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). Default: true
- prettier (boolean) Setup prettier. Default: false
- prettierOptions (javascript.PrettierOptions) Prettier options. Default: default options
- projenDevDependency (boolean) Indicates of "projen" should be installed as a devDependency. Default: true
- projenrcJs (boolean) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. Default: true if projenrcJson is false
- projenrcJsOptions (javascript.ProjenrcOptions) Options for .projenrc.js. Default: default options
- projenVersion (string) Version of projen to install. Default: Defaults to the latest version.
- pullRequestTemplate (boolean) Include a GitHub pull request template. Default: true
- pullRequestTemplateContents (Array) The contents of the pull request template. Default: default content
- release (boolean) Add release management to this project. Default: true (false for subprojects)
- releaseToNpm (boolean) Automatically release to npm when new versions are introduced. Default: false
- releaseWorkflow (boolean) DEPRECATED: renamed to release. Default: true if not a subproject
- workflowBootstrapSteps (Array<github.workflows.JobStep>) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
- workflowGitIdentity (github.GitIdentity) The git identity to use in workflows. Default: GitHub Actions
- workflowNodeVersion (string) The node version to use in GitHub workflows. Default: same as minNodeVersion
- disableTsconfig (boolean) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
- docgen (boolean) Docgen by Typedoc. Default: false
- docsDirectory (string) Docs directory. Default: "docs"
- entrypointTypes (string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
- eslint (boolean) Setup eslint. Default: true
- eslintOptions (javascript.EslintOptions) Eslint options. Default: opinionated default options
- libdir (string) Typescript artifacts output directory. Default: "lib"
- projenrcTs (boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false
- projenrcTsOptions (typescript.ProjenrcOptions) Options for .projenrc.ts. Optional
- sampleCode (boolean) Generate one-time sample in src/ and test/ if there are no files there. Default: true
- srcdir (string) Typescript sources directory. Default: "src"
- testdir (string) Jest tests directory. Tests files should be named xxx.test.ts. Default: "test"
- tsconfig (javascript.TypescriptConfigOptions) Custom TSConfig. Default: default options
- tsconfigDev (javascript.TypescriptConfigOptions) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: use the production tsconfig options
- tsconfigDevFile (string) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
- typescriptVersion (string) TypeScript version to use. Default: "latest"
- buildCommand (string) A command to execute before synthesis. Default: no build command
- cdkout (string) cdk.out directory. Default: "cdk.out"
- context (Map<string, any>) Additional context to include in cdk.json. Default: no additional context
- featureFlags (boolean) Include all feature flags in cdk.json. Default: true
- requireApproval (awscdk.ApprovalLevel) To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. Default: ApprovalLevel.BROADENING
- watchExcludes (Array) Glob patterns to exclude from cdk watch. Default: []
- watchIncludes (Array) Glob patterns to include in cdk watch. Default: []
- cdkVersion (string) Minimum version of the AWS CDK to depend on.
- cdkAssert (boolean) Warning: NodeJS only. Default: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
- cdkAssertions (boolean) Install the assertions library? Default: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
- cdkDependencies (Array) Which AWS CDKv1 modules this project requires. Optional
- cdkDependenciesAsDeps (boolean) If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies). Default: true
- cdkTestDependencies (Array) AWS CDK modules required for testing. Optional
- cdkVersionPinning (boolean) Use pinned version instead of caret version for CDK. Optional
- constructsVersion (string) Minimum version of the constructs library to depend on. Default: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
- appEntrypoint (string) The CDK app's entrypoint (relative to the source directory, which is "src" by default). Default: "main.ts"
- integrationTestAutoDiscover (boolean) Automatically discovers and creates integration tests for each .integ.ts file in under your test directory. Default: true
- lambdaAutoDiscover (boolean) Automatically adds an awscdk.LambdaFunction for each .lambda.ts handler in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project. Default: true
- lambdaExtensionAutoDiscover (boolean) Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project. Default: true
- lambdaOptions (awscdk.LambdaFunctionCommonOptions) Common options for all AWS Lambda functions. Default: default options
- cdkPipelines (boolean) Enable CDK pipelines. Default: false
- sops (SopsAspectOptions) Enable storing secrets using Mozilla SOPS. Default: no SOPS config

class TaimosCdkConstructLibrary

TypeScript library.

Extends: awscdk.AwsCdkConstructLibrary

Initializer

new TaimosCdkConstructLibrary(options: TaimosCdkConstructLibraryOptions)

options (TaimosCdkConstructLibraryOptions) No description
- name (string) This is the name of your project.
- logging (LoggerOptions) Configure logging options such as verbosity. Default: {}
- outdir (string) The root directory of the project. Default: "."
- parent (Project) The parent project, if this project is part of a bigger project. Optional
- projenCommand (string) The shell command to use in order to run the projen CLI. Default: "npx projen"
- projenrcJson (boolean) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. Default: false
- projenrcJsonOptions (ProjenrcOptions) Options for .projenrc.json. Default: default options
- autoApproveOptions (github.AutoApproveOptions) Enable and configure the 'auto approve' workflow. Default: auto approve is disabled
- autoMerge (boolean) Enable automatic merging on GitHub. Default: true
- autoMergeOptions (github.AutoMergeOptions) Configure options for automatic merging on GitHub. Default: see defaults in AutoMergeOptions
- clobber (boolean) Add a clobber task which resets the repo to origin. Default: true
- devContainer (boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false
- github (boolean) Enable GitHub integration. Default: true
- githubOptions (github.GitHubOptions) Options for GitHub integration. Default: see GitHubOptions
- gitpod (boolean) Add a Gitpod development environment. Default: false
- mergify (boolean) Whether mergify should be enabled on this repository or not. Default: true
- mergifyOptions (github.MergifyOptions) Options for mergify. Default: default options
- projectType (ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
- projenCredentials (github.GithubCredentials) Choose a method of providing GitHub API access for projen workflows. Default: use a personal access token named PROJEN_GITHUB_TOKEN
- projenTokenSecret (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. Default: "PROJEN_GITHUB_TOKEN"
- readme (SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' }
- stale (boolean) Auto-close of stale issues and pull request. Default: false
- staleOptions (github.StaleOptions) Auto-close stale issues and pull requests. Default: see defaults in StaleOptions
- vscode (boolean) Enable VSCode integration. Default: true
- allowLibraryDependencies (boolean) Allow the project to include peerDependencies and bundledDependencies. Default: true
- authorEmail (string) Author's e-mail. Optional
- authorName (string) Author's name. Optional
- authorOrganization (boolean) Author's Organization. Optional
- authorUrl (string) Author's URL / Website. Optional
- autoDetectBin (boolean) Automatically add all executables under the bin directory to your package.json file under the bin section. Default: true
- bin (Map<string, string>) Binary programs vended with your module. Optional
- bugsEmail (string) The email address to which issues should be reported. Optional
- bugsUrl (string) The url to your project's issue tracker. Optional
- bundledDeps (Array) List of dependencies to bundle into this module. Optional
- codeArtifactOptions (javascript.CodeArtifactOptions) Options for npm packages using AWS CodeArtifact. Default: undefined
- deps (Array) Runtime dependencies of this module. Default: []
- description (string) The description is just a string that helps people understand the purpose of the package. Optional
- devDeps (Array) Build dependencies for this module. Default: []
- entrypoint (string) Module entrypoint (main in package.json). Default: "lib/index.js"
- homepage (string) Package's Homepage / Website. Optional
- keywords (Array) Keywords to include in package.json. Optional
- license (string) License's SPDX identifier. Default: "Apache-2.0"
- licensed (boolean) Indicates if a license should be added. Default: true
- maxNodeVersion (string) Minimum node.js version to require via engines (inclusive). Default: no max
- minNodeVersion (string) Minimum Node.js version to require via package.json engines (inclusive). Default: no "engines" specified
- npmAccess (javascript.NpmAccess) Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
- npmRegistry (string) The host name of the npm registry to publish to. Optional
- npmRegistryUrl (string) The base URL of the npm package registry. Default: "https://registry.npmjs.org"
- npmTokenSecret (string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
- packageManager (javascript.NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN
- packageName (string) The "name" in package.json. Default: defaults to project name
- peerDependencyOptions (javascript.PeerDependencyOptions) Options for peerDeps. Optional
- peerDeps (Array) Peer dependencies for this module. Default: []
- repository (string) The repository is the location where the actual code for your package lives. Optional
- repositoryDirectory (string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional
- scopedPackagesOptions (Array<javascript.ScopedPackagesOptions>) Options for privately hosted scoped packages. Default: fetch all scoped packages from the public npm registry
- scripts (Map<string, string>) npm scripts to include. Default: {}
- stability (string) Package's Stability. Optional
- jsiiReleaseVersion (string) Version requirement of publib which is used to publish modules to npm. Default: "latest"
- majorVersion (number) Major version to release from the default branch. Default: Major version is not enforced.
- npmDistTag (string) The npmDistTag to use when publishing from the default branch. Default: "latest"
- postBuildSteps (Array<github.workflows.JobStep>) Steps to execute after build as part of the release workflow. Default: []
- prerelease (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: normal semantic versions
- publishDryRun (boolean) Instead of actually publishing to package managers, just print the publishing command. Default: false
- publishTasks (boolean) Define publishing tasks that can be executed manually as well as workflows. Default: false
- releaseBranches (Map<string, release.BranchOptions>) Defines additional release branches. Default: no additional branches are used for release. you can use addBranch() to add additional branches.
- releaseEveryCommit (boolean) Automatically release new versions every commit to one of branches in releaseBranches. Default: true
- releaseFailureIssue (boolean) Create a github issue on every failed publishing task. Default: false
- releaseFailureIssueLabel (string) The label to apply to issues indicating publish failures. Default: "failed-release"
- releaseSchedule (string) CRON schedule to trigger new releases. Default: no scheduled releases
- releaseTagPrefix (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Default: no prefix
- releaseTrigger (release.ReleaseTrigger) The release trigger to use. Default: Continuous releases (ReleaseTrigger.continuous())
- releaseWorkflowName (string) The name of the default release workflow. Default: "Release"
- releaseWorkflowSetupSteps (Array<github.workflows.JobStep>) A set of workflow steps to execute in order to setup the workflow container. Optional
- versionrcOptions (Map<string, any>) Custom configuration used when creating changelog with standard-version package. Default: standard configuration applicable for GitHub repositories
- workflowContainerImage (string) Container image to use for GitHub workflows. Default: default image
- workflowRunsOn (Array) Github Runner selection labels. Default: ["ubuntu-latest"]
- defaultReleaseBranch (string) The name of the main release branch.
- artifactsDirectory (string) A directory which will contain build artifacts. Default: "dist"
- autoApproveUpgrades (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Default: true
- buildWorkflow (boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject
- buildWorkflowTriggers (github.workflows.Triggers) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
- bundlerOptions (javascript.BundlerOptions) Options for Bundler. Optional
- codeCov (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false
- codeCovTokenSecret (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported
- copyrightOwner (string) License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined.
- copyrightPeriod (string) The copyright years to put in the LICENSE file. Default: current year
- dependabot (boolean) Use dependabot to handle dependency upgrades. Default: false
- dependabotOptions (github.DependabotOptions) Options for dependabot. Default: default options
- depsUpgrade (boolean) Use github workflows to handle dependency upgrades. Default: true
- depsUpgradeOptions (javascript.UpgradeDependenciesOptions) Options for UpgradeDependencies. Default: default options
- gitignore (Array) Additional entries to .gitignore. Optional
- jest (boolean) Setup jest unit tests. Default: true
- jestOptions (javascript.JestOptions) Jest options. Default: default options
- mutableBuild (boolean) Automatically update files modified during builds to pull-request branches. Default: true
- npmignore (Array) Additional entries to .npmignore. Optional
- npmignoreEnabled (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
- package (boolean) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). Default: true
- prettier (boolean) Setup prettier. Default: false
- prettierOptions (javascript.PrettierOptions) Prettier options. Default: default options
- projenDevDependency (boolean) Indicates of "projen" should be installed as a devDependency. Default: true
- projenrcJs (boolean) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. Default: true if projenrcJson is false
- projenrcJsOptions (javascript.ProjenrcOptions) Options for .projenrc.js. Default: default options
- projenVersion (string) Version of projen to install. Default: Defaults to the latest version.
- pullRequestTemplate (boolean) Include a GitHub pull request template. Default: true
- pullRequestTemplateContents (Array) The contents of the pull request template. Default: default content
- release (boolean) Add release management to this project. Default: true (false for subprojects)
- releaseToNpm (boolean) Automatically release to npm when new versions are introduced. Default: false
- releaseWorkflow (boolean) DEPRECATED: renamed to release. Default: true if not a subproject
- workflowBootstrapSteps (Array<github.workflows.JobStep>) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
- workflowGitIdentity (github.GitIdentity) The git identity to use in workflows. Default: GitHub Actions
- workflowNodeVersion (string) The node version to use in GitHub workflows. Default: same as minNodeVersion
- disableTsconfig (boolean) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
- docgen (boolean) Docgen by Typedoc. Default: false
- docsDirectory (string) Docs directory. Default: "docs"
- entrypointTypes (string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
- eslint (boolean) Setup eslint. Default: true
- eslintOptions (javascript.EslintOptions) Eslint options. Default: opinionated default options
- libdir (string) Typescript artifacts output directory. Default: "lib"
- projenrcTs (boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false
- projenrcTsOptions (typescript.ProjenrcOptions) Options for .projenrc.ts. Optional
- sampleCode (boolean) Generate one-time sample in src/ and test/ if there are no files there. Default: true
- srcdir (string) Typescript sources directory. Default: "src"
- testdir (string) Jest tests directory. Tests files should be named xxx.test.ts. Default: "test"
- tsconfig (javascript.TypescriptConfigOptions) Custom TSConfig. Default: default options
- tsconfigDev (javascript.TypescriptConfigOptions) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: use the production tsconfig options
- tsconfigDevFile (string) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
- typescriptVersion (string) TypeScript version to use. Default: "latest"
- author (string) The name of the library author.
- authorAddress (string) Email or URL of the library author.
- repositoryUrl (string) Git repository URL.
- compat (boolean) Automatically run API compatibility test against the latest version published to npm after compilation. Default: false
- compatIgnore (string) Name of the ignore file for API compatibility tests. Default: ".compatignore"
- docgenFilePath (string) File path for generated docs. Default: "API.md"
- dotnet (cdk.JsiiDotNetTarget) No description Optional
- excludeTypescript (Array) Accepts a list of glob patterns. Optional
- publishToGo (cdk.JsiiGoTarget) Publish Go bindings to a git repository. Default: no publishing
- publishToMaven (cdk.JsiiJavaTarget) Publish to maven. Default: no publishing
- publishToNuget (cdk.JsiiDotNetTarget) Publish to NuGet. Default: no publishing
- publishToPypi (cdk.JsiiPythonTarget) Publish to pypi. Default: no publishing
- python (cdk.JsiiPythonTarget) No description Optional
- rootdir (string) No description Default: "."
- catalog (cdk.Catalog) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. Default: new version will be announced
- cdkVersion (string) Minimum version of the AWS CDK to depend on.
- cdkAssert (boolean) Warning: NodeJS only. Default: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
- cdkAssertions (boolean) Install the assertions library? Default: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
- cdkDependencies (Array) Which AWS CDKv1 modules this project requires. Optional
- cdkDependenciesAsDeps (boolean) If this is enabled (default), all modules declared in cdkDependencies will be also added as normal dependencies (as well as peerDependencies). Default: true
- cdkTestDependencies (Array) AWS CDK modules required for testing. Optional
- cdkVersionPinning (boolean) Use pinned version instead of caret version for CDK. Optional
- constructsVersion (string) Minimum version of the constructs library to depend on. Default: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
- integrationTestAutoDiscover (boolean) Automatically discovers and creates integration tests for each .integ.ts file in under your test directory. Default: true
- lambdaAutoDiscover (boolean) Automatically adds an aws_lambda.Function for each .lambda.ts handler in your source tree. If this is disabled, you either need to explicitly call aws_lambda.Function.autoDiscover() or define a new aws_lambda.Function() for each handler. Default: true
- lambdaExtensionAutoDiscover (boolean) Automatically adds an awscdk.LambdaExtension for each .lambda-extension.ts entrypoint in your source tree. If this is disabled, you can manually add an awscdk.AutoDiscover component to your project. Default: true
- lambdaOptions (awscdk.LambdaFunctionCommonOptions) Common options for all AWS Lambda functions. Default: default options

class TaimosPrivateTypescriptLibrary

Private TypeScript library.

Extends: TaimosTypescriptLibrary

Initializer

new TaimosPrivateTypescriptLibrary(options: TaimosPrivateTypescriptLibraryOptions)

options (TaimosPrivateTypescriptLibraryOptions) No description
- name (string) This is the name of your project.
- logging (LoggerOptions) Configure logging options such as verbosity. Default: {}
- outdir (string) The root directory of the project. Default: "."
- parent (Project) The parent project, if this project is part of a bigger project. Optional
- projenCommand (string) The shell command to use in order to run the projen CLI. Default: "npx projen"
- projenrcJson (boolean) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. Default: false
- projenrcJsonOptions (ProjenrcOptions) Options for .projenrc.json. Default: default options
- autoApproveOptions (github.AutoApproveOptions) Enable and configure the 'auto approve' workflow. Default: auto approve is disabled
- autoMerge (boolean) Enable automatic merging on GitHub. Default: true
- autoMergeOptions (github.AutoMergeOptions) Configure options for automatic merging on GitHub. Default: see defaults in AutoMergeOptions
- clobber (boolean) Add a clobber task which resets the repo to origin. Default: true
- devContainer (boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false
- github (boolean) Enable GitHub integration. Default: true
- githubOptions (github.GitHubOptions) Options for GitHub integration. Default: see GitHubOptions
- gitpod (boolean) Add a Gitpod development environment. Default: false
- mergify (boolean) Whether mergify should be enabled on this repository or not. Default: true
- mergifyOptions (github.MergifyOptions) Options for mergify. Default: default options
- projectType (ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
- projenCredentials (github.GithubCredentials) Choose a method of providing GitHub API access for projen workflows. Default: use a personal access token named PROJEN_GITHUB_TOKEN
- projenTokenSecret (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. Default: "PROJEN_GITHUB_TOKEN"
- readme (SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' }
- stale (boolean) Auto-close of stale issues and pull request. Default: false
- staleOptions (github.StaleOptions) Auto-close stale issues and pull requests. Default: see defaults in StaleOptions
- vscode (boolean) Enable VSCode integration. Default: true
- allowLibraryDependencies (boolean) Allow the project to include peerDependencies and bundledDependencies. Default: true
- authorEmail (string) Author's e-mail. Optional
- authorName (string) Author's name. Optional
- authorOrganization (boolean) Author's Organization. Optional
- authorUrl (string) Author's URL / Website. Optional
- autoDetectBin (boolean) Automatically add all executables under the bin directory to your package.json file under the bin section. Default: true
- bin (Map<string, string>) Binary programs vended with your module. Optional
- bugsEmail (string) The email address to which issues should be reported. Optional
- bugsUrl (string) The url to your project's issue tracker. Optional
- bundledDeps (Array) List of dependencies to bundle into this module. Optional
- codeArtifactOptions (javascript.CodeArtifactOptions) Options for npm packages using AWS CodeArtifact. Default: undefined
- deps (Array) Runtime dependencies of this module. Default: []
- description (string) The description is just a string that helps people understand the purpose of the package. Optional
- devDeps (Array) Build dependencies for this module. Default: []
- entrypoint (string) Module entrypoint (main in package.json). Default: "lib/index.js"
- homepage (string) Package's Homepage / Website. Optional
- keywords (Array) Keywords to include in package.json. Optional
- license (string) License's SPDX identifier. Default: "Apache-2.0"
- licensed (boolean) Indicates if a license should be added. Default: true
- maxNodeVersion (string) Minimum node.js version to require via engines (inclusive). Default: no max
- minNodeVersion (string) Minimum Node.js version to require via package.json engines (inclusive). Default: no "engines" specified
- npmAccess (javascript.NpmAccess) Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
- npmRegistry (string) The host name of the npm registry to publish to. Optional
- npmRegistryUrl (string) The base URL of the npm package registry. Default: "https://registry.npmjs.org"
- npmTokenSecret (string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
- packageManager (javascript.NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN
- packageName (string) The "name" in package.json. Default: defaults to project name
- peerDependencyOptions (javascript.PeerDependencyOptions) Options for peerDeps. Optional
- peerDeps (Array) Peer dependencies for this module. Default: []
- repository (string) The repository is the location where the actual code for your package lives. Optional
- repositoryDirectory (string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional
- scopedPackagesOptions (Array<javascript.ScopedPackagesOptions>) Options for privately hosted scoped packages. Default: fetch all scoped packages from the public npm registry
- scripts (Map<string, string>) npm scripts to include. Default: {}
- stability (string) Package's Stability. Optional
- jsiiReleaseVersion (string) Version requirement of publib which is used to publish modules to npm. Default: "latest"
- majorVersion (number) Major version to release from the default branch. Default: Major version is not enforced.
- npmDistTag (string) The npmDistTag to use when publishing from the default branch. Default: "latest"
- postBuildSteps (Array<github.workflows.JobStep>) Steps to execute after build as part of the release workflow. Default: []
- prerelease (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: normal semantic versions
- publishDryRun (boolean) Instead of actually publishing to package managers, just print the publishing command. Default: false
- publishTasks (boolean) Define publishing tasks that can be executed manually as well as workflows. Default: false
- releaseBranches (Map<string, release.BranchOptions>) Defines additional release branches. Default: no additional branches are used for release. you can use addBranch() to add additional branches.
- releaseEveryCommit (boolean) Automatically release new versions every commit to one of branches in releaseBranches. Default: true
- releaseFailureIssue (boolean) Create a github issue on every failed publishing task. Default: false
- releaseFailureIssueLabel (string) The label to apply to issues indicating publish failures. Default: "failed-release"
- releaseSchedule (string) CRON schedule to trigger new releases. Default: no scheduled releases
- releaseTagPrefix (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Default: no prefix
- releaseTrigger (release.ReleaseTrigger) The release trigger to use. Default: Continuous releases (ReleaseTrigger.continuous())
- releaseWorkflowName (string) The name of the default release workflow. Default: "Release"
- releaseWorkflowSetupSteps (Array<github.workflows.JobStep>) A set of workflow steps to execute in order to setup the workflow container. Optional
- versionrcOptions (Map<string, any>) Custom configuration used when creating changelog with standard-version package. Default: standard configuration applicable for GitHub repositories
- workflowContainerImage (string) Container image to use for GitHub workflows. Default: default image
- workflowRunsOn (Array) Github Runner selection labels. Default: ["ubuntu-latest"]
- defaultReleaseBranch (string) The name of the main release branch.
- artifactsDirectory (string) A directory which will contain build artifacts. Default: "dist"
- autoApproveUpgrades (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Default: true
- buildWorkflow (boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject
- buildWorkflowTriggers (github.workflows.Triggers) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
- bundlerOptions (javascript.BundlerOptions) Options for Bundler. Optional
- codeCov (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false
- codeCovTokenSecret (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported
- copyrightOwner (string) License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined.
- copyrightPeriod (string) The copyright years to put in the LICENSE file. Default: current year
- dependabot (boolean) Use dependabot to handle dependency upgrades. Default: false
- dependabotOptions (github.DependabotOptions) Options for dependabot. Default: default options
- depsUpgrade (boolean) Use github workflows to handle dependency upgrades. Default: true
- depsUpgradeOptions (javascript.UpgradeDependenciesOptions) Options for UpgradeDependencies. Default: default options
- gitignore (Array) Additional entries to .gitignore. Optional
- jest (boolean) Setup jest unit tests. Default: true
- jestOptions (javascript.JestOptions) Jest options. Default: default options
- mutableBuild (boolean) Automatically update files modified during builds to pull-request branches. Default: true
- npmignore (Array) Additional entries to .npmignore. Optional
- npmignoreEnabled (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
- package (boolean) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). Default: true
- prettier (boolean) Setup prettier. Default: false
- prettierOptions (javascript.PrettierOptions) Prettier options. Default: default options
- projenDevDependency (boolean) Indicates of "projen" should be installed as a devDependency. Default: true
- projenrcJs (boolean) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. Default: true if projenrcJson is false
- projenrcJsOptions (javascript.ProjenrcOptions) Options for .projenrc.js. Default: default options
- projenVersion (string) Version of projen to install. Default: Defaults to the latest version.
- pullRequestTemplate (boolean) Include a GitHub pull request template. Default: true
- pullRequestTemplateContents (Array) The contents of the pull request template. Default: default content
- release (boolean) Add release management to this project. Default: true (false for subprojects)
- releaseToNpm (boolean) Automatically release to npm when new versions are introduced. Default: false
- releaseWorkflow (boolean) DEPRECATED: renamed to release. Default: true if not a subproject
- workflowBootstrapSteps (Array<github.workflows.JobStep>) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
- workflowGitIdentity (github.GitIdentity) The git identity to use in workflows. Default: GitHub Actions
- workflowNodeVersion (string) The node version to use in GitHub workflows. Default: same as minNodeVersion
- disableTsconfig (boolean) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
- docgen (boolean) Docgen by Typedoc. Default: false
- docsDirectory (string) Docs directory. Default: "docs"
- entrypointTypes (string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
- eslint (boolean) Setup eslint. Default: true
- eslintOptions (javascript.EslintOptions) Eslint options. Default: opinionated default options
- libdir (string) Typescript artifacts output directory. Default: "lib"
- projenrcTs (boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false
- projenrcTsOptions (typescript.ProjenrcOptions) Options for .projenrc.ts. Optional
- sampleCode (boolean) Generate one-time sample in src/ and test/ if there are no files there. Default: true
- srcdir (string) Typescript sources directory. Default: "src"
- testdir (string) Jest tests directory. Tests files should be named xxx.test.ts. Default: "test"
- tsconfig (javascript.TypescriptConfigOptions) Custom TSConfig. Default: default options
- tsconfigDev (javascript.TypescriptConfigOptions) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: use the production tsconfig options
- tsconfigDevFile (string) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
- typescriptVersion (string) TypeScript version to use. Default: "latest"

Properties

Name	Type	Description
npmConfig	`javascript.NpmConfig`

class TaimosTypescriptLibrary

TypeScript library.

Extends: typescript.TypeScriptProject

Initializer

new TaimosTypescriptLibrary(options: TaimosTypescriptLibraryOptions)

options (TaimosTypescriptLibraryOptions) No description
- name (string) This is the name of your project.
- logging (LoggerOptions) Configure logging options such as verbosity. Default: {}
- outdir (string) The root directory of the project. Default: "."
- parent (Project) The parent project, if this project is part of a bigger project. Optional
- projenCommand (string) The shell command to use in order to run the projen CLI. Default: "npx projen"
- projenrcJson (boolean) Generate (once) .projenrc.json (in JSON). Set to false in order to disable .projenrc.json generation. Default: false
- projenrcJsonOptions (ProjenrcOptions) Options for .projenrc.json. Default: default options
- autoApproveOptions (github.AutoApproveOptions) Enable and configure the 'auto approve' workflow. Default: auto approve is disabled
- autoMerge (boolean) Enable automatic merging on GitHub. Default: true
- autoMergeOptions (github.AutoMergeOptions) Configure options for automatic merging on GitHub. Default: see defaults in AutoMergeOptions
- clobber (boolean) Add a clobber task which resets the repo to origin. Default: true
- devContainer (boolean) Add a VSCode development environment (used for GitHub Codespaces). Default: false
- github (boolean) Enable GitHub integration. Default: true
- githubOptions (github.GitHubOptions) Options for GitHub integration. Default: see GitHubOptions
- gitpod (boolean) Add a Gitpod development environment. Default: false
- mergify (boolean) Whether mergify should be enabled on this repository or not. Default: true
- mergifyOptions (github.MergifyOptions) Options for mergify. Default: default options
- projectType (ProjectType) Which type of project this is (library/app). Default: ProjectType.UNKNOWN
- projenCredentials (github.GithubCredentials) Choose a method of providing GitHub API access for projen workflows. Default: use a personal access token named PROJEN_GITHUB_TOKEN
- projenTokenSecret (string) The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. Default: "PROJEN_GITHUB_TOKEN"
- readme (SampleReadmeProps) The README setup. Default: { filename: 'README.md', contents: '# replace this' }
- stale (boolean) Auto-close of stale issues and pull request. Default: false
- staleOptions (github.StaleOptions) Auto-close stale issues and pull requests. Default: see defaults in StaleOptions
- vscode (boolean) Enable VSCode integration. Default: true
- allowLibraryDependencies (boolean) Allow the project to include peerDependencies and bundledDependencies. Default: true
- authorEmail (string) Author's e-mail. Optional
- authorName (string) Author's name. Optional
- authorOrganization (boolean) Author's Organization. Optional
- authorUrl (string) Author's URL / Website. Optional
- autoDetectBin (boolean) Automatically add all executables under the bin directory to your package.json file under the bin section. Default: true
- bin (Map<string, string>) Binary programs vended with your module. Optional
- bugsEmail (string) The email address to which issues should be reported. Optional
- bugsUrl (string) The url to your project's issue tracker. Optional
- bundledDeps (Array) List of dependencies to bundle into this module. Optional
- codeArtifactOptions (javascript.CodeArtifactOptions) Options for npm packages using AWS CodeArtifact. Default: undefined
- deps (Array) Runtime dependencies of this module. Default: []
- description (string) The description is just a string that helps people understand the purpose of the package. Optional
- devDeps (Array) Build dependencies for this module. Default: []
- entrypoint (string) Module entrypoint (main in package.json). Default: "lib/index.js"
- homepage (string) Package's Homepage / Website. Optional
- keywords (Array) Keywords to include in package.json. Optional
- license (string) License's SPDX identifier. Default: "Apache-2.0"
- licensed (boolean) Indicates if a license should be added. Default: true
- maxNodeVersion (string) Minimum node.js version to require via engines (inclusive). Default: no max
- minNodeVersion (string) Minimum Node.js version to require via package.json engines (inclusive). Default: no "engines" specified
- npmAccess (javascript.NpmAccess) Access level of the npm package. Default: for scoped packages (e.g. foo@bar), the default is NpmAccess.RESTRICTED, for non-scoped packages, the default is NpmAccess.PUBLIC.
- npmRegistry (string) The host name of the npm registry to publish to. Optional
- npmRegistryUrl (string) The base URL of the npm package registry. Default: "https://registry.npmjs.org"
- npmTokenSecret (string) GitHub secret which contains the NPM token to use when publishing packages. Default: "NPM_TOKEN"
- packageManager (javascript.NodePackageManager) The Node Package Manager used to execute scripts. Default: NodePackageManager.YARN
- packageName (string) The "name" in package.json. Default: defaults to project name
- peerDependencyOptions (javascript.PeerDependencyOptions) Options for peerDeps. Optional
- peerDeps (Array) Peer dependencies for this module. Default: []
- repository (string) The repository is the location where the actual code for your package lives. Optional
- repositoryDirectory (string) If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. Optional
- scopedPackagesOptions (Array<javascript.ScopedPackagesOptions>) Options for privately hosted scoped packages. Default: fetch all scoped packages from the public npm registry
- scripts (Map<string, string>) npm scripts to include. Default: {}
- stability (string) Package's Stability. Optional
- jsiiReleaseVersion (string) Version requirement of publib which is used to publish modules to npm. Default: "latest"
- majorVersion (number) Major version to release from the default branch. Default: Major version is not enforced.
- npmDistTag (string) The npmDistTag to use when publishing from the default branch. Default: "latest"
- postBuildSteps (Array<github.workflows.JobStep>) Steps to execute after build as part of the release workflow. Default: []
- prerelease (string) Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). Default: normal semantic versions
- publishDryRun (boolean) Instead of actually publishing to package managers, just print the publishing command. Default: false
- publishTasks (boolean) Define publishing tasks that can be executed manually as well as workflows. Default: false
- releaseBranches (Map<string, release.BranchOptions>) Defines additional release branches. Default: no additional branches are used for release. you can use addBranch() to add additional branches.
- releaseEveryCommit (boolean) Automatically release new versions every commit to one of branches in releaseBranches. Default: true
- releaseFailureIssue (boolean) Create a github issue on every failed publishing task. Default: false
- releaseFailureIssueLabel (string) The label to apply to issues indicating publish failures. Default: "failed-release"
- releaseSchedule (string) CRON schedule to trigger new releases. Default: no scheduled releases
- releaseTagPrefix (string) Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. Default: no prefix
- releaseTrigger (release.ReleaseTrigger) The release trigger to use. Default: Continuous releases (ReleaseTrigger.continuous())
- releaseWorkflowName (string) The name of the default release workflow. Default: "Release"
- releaseWorkflowSetupSteps (Array<github.workflows.JobStep>) A set of workflow steps to execute in order to setup the workflow container. Optional
- versionrcOptions (Map<string, any>) Custom configuration used when creating changelog with standard-version package. Default: standard configuration applicable for GitHub repositories
- workflowContainerImage (string) Container image to use for GitHub workflows. Default: default image
- workflowRunsOn (Array) Github Runner selection labels. Default: ["ubuntu-latest"]
- defaultReleaseBranch (string) The name of the main release branch.
- artifactsDirectory (string) A directory which will contain build artifacts. Default: "dist"
- autoApproveUpgrades (boolean) Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). Default: true
- buildWorkflow (boolean) Define a GitHub workflow for building PRs. Default: true if not a subproject
- buildWorkflowTriggers (github.workflows.Triggers) Build workflow triggers. Default: "{ pullRequest: {}, workflowDispatch: {} }"
- bundlerOptions (javascript.BundlerOptions) Options for Bundler. Optional
- codeCov (boolean) Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. Default: false
- codeCovTokenSecret (string) Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. Default: if this option is not specified, only public repositories are supported
- copyrightOwner (string) License copyright owner. Default: defaults to the value of authorName or "" if authorName is undefined.
- copyrightPeriod (string) The copyright years to put in the LICENSE file. Default: current year
- dependabot (boolean) Use dependabot to handle dependency upgrades. Default: false
- dependabotOptions (github.DependabotOptions) Options for dependabot. Default: default options
- depsUpgrade (boolean) Use github workflows to handle dependency upgrades. Default: true
- depsUpgradeOptions (javascript.UpgradeDependenciesOptions) Options for UpgradeDependencies. Default: default options
- gitignore (Array) Additional entries to .gitignore. Optional
- jest (boolean) Setup jest unit tests. Default: true
- jestOptions (javascript.JestOptions) Jest options. Default: default options
- mutableBuild (boolean) Automatically update files modified during builds to pull-request branches. Default: true
- npmignore (Array) Additional entries to .npmignore. Optional
- npmignoreEnabled (boolean) Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. Default: true
- package (boolean) Defines a package task that will produce an npm tarball under the artifacts directory (e.g. dist). Default: true
- prettier (boolean) Setup prettier. Default: false
- prettierOptions (javascript.PrettierOptions) Prettier options. Default: default options
- projenDevDependency (boolean) Indicates of "projen" should be installed as a devDependency. Default: true
- projenrcJs (boolean) Generate (once) .projenrc.js (in JavaScript). Set to false in order to disable .projenrc.js generation. Default: true if projenrcJson is false
- projenrcJsOptions (javascript.ProjenrcOptions) Options for .projenrc.js. Default: default options
- projenVersion (string) Version of projen to install. Default: Defaults to the latest version.
- pullRequestTemplate (boolean) Include a GitHub pull request template. Default: true
- pullRequestTemplateContents (Array) The contents of the pull request template. Default: default content
- release (boolean) Add release management to this project. Default: true (false for subprojects)
- releaseToNpm (boolean) Automatically release to npm when new versions are introduced. Default: false
- releaseWorkflow (boolean) DEPRECATED: renamed to release. Default: true if not a subproject
- workflowBootstrapSteps (Array<github.workflows.JobStep>) Workflow steps to use in order to bootstrap this repo. Default: "yarn install --frozen-lockfile && yarn projen"
- workflowGitIdentity (github.GitIdentity) The git identity to use in workflows. Default: GitHub Actions
- workflowNodeVersion (string) The node version to use in GitHub workflows. Default: same as minNodeVersion
- disableTsconfig (boolean) Do not generate a tsconfig.json file (used by jsii projects since tsconfig.json is generated by the jsii compiler). Default: false
- docgen (boolean) Docgen by Typedoc. Default: false
- docsDirectory (string) Docs directory. Default: "docs"
- entrypointTypes (string) The .d.ts file that includes the type declarations for this module. Default: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
- eslint (boolean) Setup eslint. Default: true
- eslintOptions (javascript.EslintOptions) Eslint options. Default: opinionated default options
- libdir (string) Typescript artifacts output directory. Default: "lib"
- projenrcTs (boolean) Use TypeScript for your projenrc file (.projenrc.ts). Default: false
- projenrcTsOptions (typescript.ProjenrcOptions) Options for .projenrc.ts. Optional
- sampleCode (boolean) Generate one-time sample in src/ and test/ if there are no files there. Default: true
- srcdir (string) Typescript sources directory. Default: "src"
- testdir (string) Jest tests directory. Tests files should be named xxx.test.ts. Default: "test"
- tsconfig (javascript.TypescriptConfigOptions) Custom TSConfig. Default: default options
- tsconfigDev (javascript.TypescriptConfigOptions) Custom tsconfig options for the development tsconfig.json file (used for testing). Default: use the production tsconfig options
- tsconfigDevFile (string) The name of the development tsconfig.json file. Default: "tsconfig.dev.json"
- typescriptVersion (string) TypeScript version to use. Default: "latest"

struct PrivateTaimosCdkAppOptions

Name	Type	Description
cdkVersion🔹	`string`	Minimum version of the AWS CDK to depend on.
defaultReleaseBranch🔹	`string`	The name of the main release branch.
name🔹	`string`	This is the name of your project.
allowLibraryDependencies?🔹	`boolean`	Allow the project to include `peerDependencies` and `bundledDependencies`. *Default*: true
appEntrypoint?🔹	`string`	The CDK app's entrypoint (relative to the source directory, which is "src" by default). *Default*: "main.ts"
artifactsDirectory?🔹	`string`	A directory which will contain build artifacts. *Default*: "dist"
authorEmail?🔹	`string`	Author's e-mail. *Optional*
authorName?🔹	`string`	Author's name. *Optional*
authorOrganization?🔹	`boolean`	Author's Organization. *Optional*
authorUrl?🔹	`string`	Author's URL / Website. *Optional*
autoApproveOptions?🔹	`github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow. *Default*: auto approve is disabled
autoApproveUpgrades?🔹	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). *Default*: true
autoDetectBin?🔹	`boolean`	Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. *Default*: true
autoMerge?🔹	`boolean`	Enable automatic merging on GitHub. *Default*: true
autoMergeOptions?🔹	`github.AutoMergeOptions`	Configure options for automatic merging on GitHub. *Default*: see defaults in `AutoMergeOptions`
bin?🔹	`Map<string, string>`	Binary programs vended with your module. *Optional*
bugsEmail?🔹	`string`	The email address to which issues should be reported. *Optional*
bugsUrl?🔹	`string`	The url to your project's issue tracker. *Optional*
buildCommand?🔹	`string`	A command to execute before synthesis. *Default*: no build command
buildWorkflow?🔹	`boolean`	Define a GitHub workflow for building PRs. *Default*: true if not a subproject
buildWorkflowTriggers?🔹	`github.workflows.Triggers`	Build workflow triggers. *Default*: "{ pullRequest: {}, workflowDispatch: {} }"
bundledDeps?🔹	`Array`	List of dependencies to bundle into this module. *Optional*
bundlerOptions?🔹	`javascript.BundlerOptions`	Options for `Bundler`. *Optional*
cdkAssert?⚠️	`boolean`	Warning: NodeJS only. *Default*: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
cdkAssertions?🔹	`boolean`	Install the assertions library? *Default*: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
cdkDependencies?⚠️	`Array`	Which AWS CDKv1 modules this project requires. *Optional*
cdkDependenciesAsDeps?⚠️	`boolean`	If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). *Default*: true
cdkPipelines?	`boolean`	Enable CDK pipelines. *Default*: false
cdkTestDependencies?⚠️	`Array`	AWS CDK modules required for testing. *Optional*
cdkVersionPinning?🔹	`boolean`	Use pinned version instead of caret version for CDK. *Optional*
cdkout?🔹	`string`	cdk.out directory. *Default*: "cdk.out"
clobber?🔹	`boolean`	Add a `clobber` task which resets the repo to origin. *Default*: true
codeArtifactOptions?🔹	`javascript.CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact. *Default*: undefined
codeCov?🔹	`boolean`	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. *Default*: false
codeCovTokenSecret?🔹	`string`	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. *Default*: if this option is not specified, only public repositories are supported
constructsVersion?🔹	`string`	Minimum version of the `constructs` library to depend on. *Default*: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
context?🔹	`Map<string, any>`	Additional context to include in `cdk.json`. *Default*: no additional context
copyrightOwner?🔹	`string`	License copyright owner. *Default*: defaults to the value of authorName or "" if `authorName` is undefined.
copyrightPeriod?🔹	`string`	The copyright years to put in the LICENSE file. *Default*: current year
dependabot?🔹	`boolean`	Use dependabot to handle dependency upgrades. *Default*: false
dependabotOptions?🔹	`github.DependabotOptions`	Options for dependabot. *Default*: default options
deps?🔹	`Array`	Runtime dependencies of this module. *Default*: []
depsUpgrade?🔹	`boolean`	Use github workflows to handle dependency upgrades. *Default*: true
depsUpgradeOptions?🔹	`javascript.UpgradeDependenciesOptions`	Options for `UpgradeDependencies`. *Default*: default options
description?🔹	`string`	The description is just a string that helps people understand the purpose of the package. *Optional*
devContainer?🔹	`boolean`	Add a VSCode development environment (used for GitHub Codespaces). *Default*: false
devDeps?🔹	`Array`	Build dependencies for this module. *Default*: []
disableTsconfig?🔹	`boolean`	Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). *Default*: false
docgen?🔹	`boolean`	Docgen by Typedoc. *Default*: false
docsDirectory?🔹	`string`	Docs directory. *Default*: "docs"
entrypoint?🔹	`string`	Module entrypoint (`main` in `package.json`). *Default*: "lib/index.js"
entrypointTypes?🔹	`string`	The .d.ts file that includes the type declarations for this module. *Default*: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
eslint?🔹	`boolean`	Setup eslint. *Default*: true
eslintOptions?🔹	`javascript.EslintOptions`	Eslint options. *Default*: opinionated default options
featureFlags?🔹	`boolean`	Include all feature flags in cdk.json. *Default*: true
github?🔹	`boolean`	Enable GitHub integration. *Default*: true
githubOptions?🔹	`github.GitHubOptions`	Options for GitHub integration. *Default*: see GitHubOptions
gitignore?🔹	`Array`	Additional entries to .gitignore. *Optional*
gitpod?🔹	`boolean`	Add a Gitpod development environment. *Default*: false
homepage?🔹	`string`	Package's Homepage / Website. *Optional*
integrationTestAutoDiscover?🔹	`boolean`	Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. *Default*: true
jest?🔹	`boolean`	Setup jest unit tests. *Default*: true
jestOptions?🔹	`javascript.JestOptions`	Jest options. *Default*: default options
jsiiReleaseVersion?🔹	`string`	Version requirement of `publib` which is used to publish modules to npm. *Default*: "latest"
keywords?🔹	`Array`	Keywords to include in `package.json`. *Optional*
lambdaAutoDiscover?🔹	`boolean`	Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. *Default*: true
lambdaExtensionAutoDiscover?🔹	`boolean`	Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. *Default*: true
lambdaOptions?🔹	`awscdk.LambdaFunctionCommonOptions`	Common options for all AWS Lambda functions. *Default*: default options
libdir?🔹	`string`	Typescript artifacts output directory. *Default*: "lib"
license?🔹	`string`	License's SPDX identifier. *Default*: "Apache-2.0"
licensed?🔹	`boolean`	Indicates if a license should be added. *Default*: true
logging?🔹	`LoggerOptions`	Configure logging options such as verbosity. *Default*: {}
majorVersion?🔹	`number`	Major version to release from the default branch. *Default*: Major version is not enforced.
maxNodeVersion?🔹	`string`	Minimum node.js version to require via `engines` (inclusive). *Default*: no max
mergify?⚠️	`boolean`	Whether mergify should be enabled on this repository or not. *Default*: true
mergifyOptions?⚠️	`github.MergifyOptions`	Options for mergify. *Default*: default options
minNodeVersion?🔹	`string`	Minimum Node.js version to require via package.json `engines` (inclusive). *Default*: no "engines" specified
mutableBuild?🔹	`boolean`	Automatically update files modified during builds to pull-request branches. *Default*: true
npmAccess?🔹	`javascript.NpmAccess`	Access level of the npm package. *Default*: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmDistTag?🔹	`string`	The npmDistTag to use when publishing from the default branch. *Default*: "latest"
npmRegistry?⚠️	`string`	The host name of the npm registry to publish to. *Optional*
npmRegistryUrl?🔹	`string`	The base URL of the npm package registry. *Default*: "https://registry.npmjs.org"
npmTokenSecret?🔹	`string`	GitHub secret which contains the NPM token to use when publishing packages. *Default*: "NPM_TOKEN"
npmignore?⚠️	`Array`	Additional entries to .npmignore. *Optional*
npmignoreEnabled?🔹	`boolean`	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. *Default*: true
outdir?🔹	`string`	The root directory of the project. *Default*: "."
package?🔹	`boolean`	Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). *Default*: true
packageManager?🔹	`javascript.NodePackageManager`	The Node Package Manager used to execute scripts. *Default*: NodePackageManager.YARN
packageName?🔹	`string`	The "name" in package.json. *Default*: defaults to project name
parent?🔹	`Project`	The parent project, if this project is part of a bigger project. *Optional*
peerDependencyOptions?🔹	`javascript.PeerDependencyOptions`	Options for `peerDeps`. *Optional*
peerDeps?🔹	`Array`	Peer dependencies for this module. *Default*: []
postBuildSteps?🔹	`Array<github.workflows.JobStep>`	Steps to execute after build as part of the release workflow. *Default*: []
prerelease?🔹	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). *Default*: normal semantic versions
prettier?🔹	`boolean`	Setup prettier. *Default*: false
prettierOptions?🔹	`javascript.PrettierOptions`	Prettier options. *Default*: default options
projectType?⚠️	`ProjectType`	Which type of project this is (library/app). *Default*: ProjectType.UNKNOWN
projenCommand?🔹	`string`	The shell command to use in order to run the projen CLI. *Default*: "npx projen"
projenCredentials?🔹	`github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows. *Default*: use a personal access token named PROJEN_GITHUB_TOKEN
projenDevDependency?🔹	`boolean`	Indicates of "projen" should be installed as a devDependency. *Default*: true
projenTokenSecret?⚠️	`string`	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. *Default*: "PROJEN_GITHUB_TOKEN"
projenVersion?🔹	`string`	Version of projen to install. *Default*: Defaults to the latest version.
projenrcJs?🔹	`boolean`	Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. *Default*: true if projenrcJson is false
projenrcJsOptions?🔹	`javascript.ProjenrcOptions`	Options for .projenrc.js. *Default*: default options
projenrcJson?🔹	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. *Default*: false
projenrcJsonOptions?🔹	`ProjenrcOptions`	Options for .projenrc.json. *Default*: default options
projenrcTs?🔹	`boolean`	Use TypeScript for your projenrc file (`.projenrc.ts`). *Default*: false
projenrcTsOptions?🔹	`typescript.ProjenrcOptions`	Options for .projenrc.ts. *Optional*
publishDryRun?🔹	`boolean`	Instead of actually publishing to package managers, just print the publishing command. *Default*: false
publishTasks?🔹	`boolean`	Define publishing tasks that can be executed manually as well as workflows. *Default*: false
pullRequestTemplate?🔹	`boolean`	Include a GitHub pull request template. *Default*: true
pullRequestTemplateContents?🔹	`Array`	The contents of the pull request template. *Default*: default content
readme?🔹	`SampleReadmeProps`	The README setup. *Default*: { filename: 'README.md', contents: '# replace this' }
release?🔹	`boolean`	Add release management to this project. *Default*: true (false for subprojects)
releaseBranches?🔹	`Map<string, release.BranchOptions>`	Defines additional release branches. *Default*: no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseEveryCommit?⚠️	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`. *Default*: true
releaseFailureIssue?🔹	`boolean`	Create a github issue on every failed publishing task. *Default*: false
releaseFailureIssueLabel?🔹	`string`	The label to apply to issues indicating publish failures. *Default*: "failed-release"
releaseSchedule?⚠️	`string`	CRON schedule to trigger new releases. *Default*: no scheduled releases
releaseTagPrefix?🔹	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. *Default*: no prefix
releaseToNpm?🔹	`boolean`	Automatically release to npm when new versions are introduced. *Default*: false
releaseTrigger?🔹	`release.ReleaseTrigger`	The release trigger to use. *Default*: Continuous releases (`ReleaseTrigger.continuous()`)
releaseWorkflow?⚠️	`boolean`	DEPRECATED: renamed to `release`. *Default*: true if not a subproject
releaseWorkflowName?🔹	`string`	The name of the default release workflow. *Default*: "Release"
releaseWorkflowSetupSteps?🔹	`Array<github.workflows.JobStep>`	A set of workflow steps to execute in order to setup the workflow container. *Optional*
repository?🔹	`string`	The repository is the location where the actual code for your package lives. *Optional*
repositoryDirectory?🔹	`string`	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. *Optional*
requireApproval?🔹	`awscdk.ApprovalLevel`	To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. *Default*: ApprovalLevel.BROADENING
sampleCode?🔹	`boolean`	Generate one-time sample in `src/` and `test/` if there are no files there. *Default*: true
scopedPackagesOptions?🔹	`Array<javascript.ScopedPackagesOptions>`	Options for privately hosted scoped packages. *Default*: fetch all scoped packages from the public npm registry
scripts?🔹	`Map<string, string>`	npm scripts to include. *Default*: {}
sops?	`SopsAspectOptions`	Enable storing secrets using Mozilla SOPS. *Default*: no SOPS config
srcdir?🔹	`string`	Typescript sources directory. *Default*: "src"
stability?🔹	`string`	Package's Stability. *Optional*
stale?🔹	`boolean`	Auto-close of stale issues and pull request. *Default*: false
staleOptions?🔹	`github.StaleOptions`	Auto-close stale issues and pull requests. *Default*: see defaults in `StaleOptions`
testdir?🔹	`string`	Jest tests directory. Tests files should be named `xxx.test.ts`. *Default*: "test"
tsconfig?🔹	`javascript.TypescriptConfigOptions`	Custom TSConfig. *Default*: default options
tsconfigDev?🔹	`javascript.TypescriptConfigOptions`	Custom tsconfig options for the development tsconfig.json file (used for testing). *Default*: use the production tsconfig options
tsconfigDevFile?🔹	`string`	The name of the development tsconfig.json file. *Default*: "tsconfig.dev.json"
typescriptVersion?🔹	`string`	TypeScript version to use. *Default*: "latest"
versionrcOptions?🔹	`Map<string, any>`	Custom configuration used when creating changelog with standard-version package. *Default*: standard configuration applicable for GitHub repositories
vscode?🔹	`boolean`	Enable VSCode integration. *Default*: true
watchExcludes?🔹	`Array`	Glob patterns to exclude from `cdk watch`. *Default*: []
watchIncludes?🔹	`Array`	Glob patterns to include in `cdk watch`. *Default*: []
workflowBootstrapSteps?🔹	`Array<github.workflows.JobStep>`	Workflow steps to use in order to bootstrap this repo. *Default*: "yarn install --frozen-lockfile && yarn projen"
workflowContainerImage?🔹	`string`	Container image to use for GitHub workflows. *Default*: default image
workflowGitIdentity?🔹	`github.GitIdentity`	The git identity to use in workflows. *Default*: GitHub Actions
workflowNodeVersion?🔹	`string`	The node version to use in GitHub workflows. *Default*: same as `minNodeVersion`
workflowRunsOn?🔹	`Array`	Github Runner selection labels. *Default*: ["ubuntu-latest"]

struct SopsAspectOptions

Name	Type	Description
secrets	`Map<string, string>`	Define a mapping of SOPS files to SecretsManager secrets.

struct TaimosCdkAppOptions

Name	Type	Description
cdkVersion🔹	`string`	Minimum version of the AWS CDK to depend on.
defaultReleaseBranch🔹	`string`	The name of the main release branch.
name🔹	`string`	This is the name of your project.
allowLibraryDependencies?🔹	`boolean`	Allow the project to include `peerDependencies` and `bundledDependencies`. *Default*: true
appEntrypoint?🔹	`string`	The CDK app's entrypoint (relative to the source directory, which is "src" by default). *Default*: "main.ts"
artifactsDirectory?🔹	`string`	A directory which will contain build artifacts. *Default*: "dist"
authorEmail?🔹	`string`	Author's e-mail. *Optional*
authorName?🔹	`string`	Author's name. *Optional*
authorOrganization?🔹	`boolean`	Author's Organization. *Optional*
authorUrl?🔹	`string`	Author's URL / Website. *Optional*
autoApproveOptions?🔹	`github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow. *Default*: auto approve is disabled
autoApproveUpgrades?🔹	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). *Default*: true
autoDetectBin?🔹	`boolean`	Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. *Default*: true
autoMerge?🔹	`boolean`	Enable automatic merging on GitHub. *Default*: true
autoMergeOptions?🔹	`github.AutoMergeOptions`	Configure options for automatic merging on GitHub. *Default*: see defaults in `AutoMergeOptions`
bin?🔹	`Map<string, string>`	Binary programs vended with your module. *Optional*
bugsEmail?🔹	`string`	The email address to which issues should be reported. *Optional*
bugsUrl?🔹	`string`	The url to your project's issue tracker. *Optional*
buildCommand?🔹	`string`	A command to execute before synthesis. *Default*: no build command
buildWorkflow?🔹	`boolean`	Define a GitHub workflow for building PRs. *Default*: true if not a subproject
buildWorkflowTriggers?🔹	`github.workflows.Triggers`	Build workflow triggers. *Default*: "{ pullRequest: {}, workflowDispatch: {} }"
bundledDeps?🔹	`Array`	List of dependencies to bundle into this module. *Optional*
bundlerOptions?🔹	`javascript.BundlerOptions`	Options for `Bundler`. *Optional*
cdkAssert?⚠️	`boolean`	Warning: NodeJS only. *Default*: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
cdkAssertions?🔹	`boolean`	Install the assertions library? *Default*: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
cdkDependencies?⚠️	`Array`	Which AWS CDKv1 modules this project requires. *Optional*
cdkDependenciesAsDeps?⚠️	`boolean`	If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). *Default*: true
cdkPipelines?	`boolean`	Enable CDK pipelines. *Default*: false
cdkTestDependencies?⚠️	`Array`	AWS CDK modules required for testing. *Optional*
cdkVersionPinning?🔹	`boolean`	Use pinned version instead of caret version for CDK. *Optional*
cdkout?🔹	`string`	cdk.out directory. *Default*: "cdk.out"
clobber?🔹	`boolean`	Add a `clobber` task which resets the repo to origin. *Default*: true
codeArtifactOptions?🔹	`javascript.CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact. *Default*: undefined
codeCov?🔹	`boolean`	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. *Default*: false
codeCovTokenSecret?🔹	`string`	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. *Default*: if this option is not specified, only public repositories are supported
constructsVersion?🔹	`string`	Minimum version of the `constructs` library to depend on. *Default*: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
context?🔹	`Map<string, any>`	Additional context to include in `cdk.json`. *Default*: no additional context
copyrightOwner?🔹	`string`	License copyright owner. *Default*: defaults to the value of authorName or "" if `authorName` is undefined.
copyrightPeriod?🔹	`string`	The copyright years to put in the LICENSE file. *Default*: current year
dependabot?🔹	`boolean`	Use dependabot to handle dependency upgrades. *Default*: false
dependabotOptions?🔹	`github.DependabotOptions`	Options for dependabot. *Default*: default options
deps?🔹	`Array`	Runtime dependencies of this module. *Default*: []
depsUpgrade?🔹	`boolean`	Use github workflows to handle dependency upgrades. *Default*: true
depsUpgradeOptions?🔹	`javascript.UpgradeDependenciesOptions`	Options for `UpgradeDependencies`. *Default*: default options
description?🔹	`string`	The description is just a string that helps people understand the purpose of the package. *Optional*
devContainer?🔹	`boolean`	Add a VSCode development environment (used for GitHub Codespaces). *Default*: false
devDeps?🔹	`Array`	Build dependencies for this module. *Default*: []
disableTsconfig?🔹	`boolean`	Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). *Default*: false
docgen?🔹	`boolean`	Docgen by Typedoc. *Default*: false
docsDirectory?🔹	`string`	Docs directory. *Default*: "docs"
entrypoint?🔹	`string`	Module entrypoint (`main` in `package.json`). *Default*: "lib/index.js"
entrypointTypes?🔹	`string`	The .d.ts file that includes the type declarations for this module. *Default*: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
eslint?🔹	`boolean`	Setup eslint. *Default*: true
eslintOptions?🔹	`javascript.EslintOptions`	Eslint options. *Default*: opinionated default options
featureFlags?🔹	`boolean`	Include all feature flags in cdk.json. *Default*: true
github?🔹	`boolean`	Enable GitHub integration. *Default*: true
githubOptions?🔹	`github.GitHubOptions`	Options for GitHub integration. *Default*: see GitHubOptions
gitignore?🔹	`Array`	Additional entries to .gitignore. *Optional*
gitpod?🔹	`boolean`	Add a Gitpod development environment. *Default*: false
homepage?🔹	`string`	Package's Homepage / Website. *Optional*
integrationTestAutoDiscover?🔹	`boolean`	Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. *Default*: true
jest?🔹	`boolean`	Setup jest unit tests. *Default*: true
jestOptions?🔹	`javascript.JestOptions`	Jest options. *Default*: default options
jsiiReleaseVersion?🔹	`string`	Version requirement of `publib` which is used to publish modules to npm. *Default*: "latest"
keywords?🔹	`Array`	Keywords to include in `package.json`. *Optional*
lambdaAutoDiscover?🔹	`boolean`	Automatically adds an `awscdk.LambdaFunction` for each `.lambda.ts` handler in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. *Default*: true
lambdaExtensionAutoDiscover?🔹	`boolean`	Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. *Default*: true
lambdaOptions?🔹	`awscdk.LambdaFunctionCommonOptions`	Common options for all AWS Lambda functions. *Default*: default options
libdir?🔹	`string`	Typescript artifacts output directory. *Default*: "lib"
license?🔹	`string`	License's SPDX identifier. *Default*: "Apache-2.0"
licensed?🔹	`boolean`	Indicates if a license should be added. *Default*: true
logging?🔹	`LoggerOptions`	Configure logging options such as verbosity. *Default*: {}
majorVersion?🔹	`number`	Major version to release from the default branch. *Default*: Major version is not enforced.
maxNodeVersion?🔹	`string`	Minimum node.js version to require via `engines` (inclusive). *Default*: no max
mergify?⚠️	`boolean`	Whether mergify should be enabled on this repository or not. *Default*: true
mergifyOptions?⚠️	`github.MergifyOptions`	Options for mergify. *Default*: default options
minNodeVersion?🔹	`string`	Minimum Node.js version to require via package.json `engines` (inclusive). *Default*: no "engines" specified
mutableBuild?🔹	`boolean`	Automatically update files modified during builds to pull-request branches. *Default*: true
npmAccess?🔹	`javascript.NpmAccess`	Access level of the npm package. *Default*: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmDistTag?🔹	`string`	The npmDistTag to use when publishing from the default branch. *Default*: "latest"
npmRegistry?⚠️	`string`	The host name of the npm registry to publish to. *Optional*
npmRegistryUrl?🔹	`string`	The base URL of the npm package registry. *Default*: "https://registry.npmjs.org"
npmTokenSecret?🔹	`string`	GitHub secret which contains the NPM token to use when publishing packages. *Default*: "NPM_TOKEN"
npmignore?⚠️	`Array`	Additional entries to .npmignore. *Optional*
npmignoreEnabled?🔹	`boolean`	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. *Default*: true
outdir?🔹	`string`	The root directory of the project. *Default*: "."
package?🔹	`boolean`	Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). *Default*: true
packageManager?🔹	`javascript.NodePackageManager`	The Node Package Manager used to execute scripts. *Default*: NodePackageManager.YARN
packageName?🔹	`string`	The "name" in package.json. *Default*: defaults to project name
parent?🔹	`Project`	The parent project, if this project is part of a bigger project. *Optional*
peerDependencyOptions?🔹	`javascript.PeerDependencyOptions`	Options for `peerDeps`. *Optional*
peerDeps?🔹	`Array`	Peer dependencies for this module. *Default*: []
postBuildSteps?🔹	`Array<github.workflows.JobStep>`	Steps to execute after build as part of the release workflow. *Default*: []
prerelease?🔹	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). *Default*: normal semantic versions
prettier?🔹	`boolean`	Setup prettier. *Default*: false
prettierOptions?🔹	`javascript.PrettierOptions`	Prettier options. *Default*: default options
projectType?⚠️	`ProjectType`	Which type of project this is (library/app). *Default*: ProjectType.UNKNOWN
projenCommand?🔹	`string`	The shell command to use in order to run the projen CLI. *Default*: "npx projen"
projenCredentials?🔹	`github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows. *Default*: use a personal access token named PROJEN_GITHUB_TOKEN
projenDevDependency?🔹	`boolean`	Indicates of "projen" should be installed as a devDependency. *Default*: true
projenTokenSecret?⚠️	`string`	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. *Default*: "PROJEN_GITHUB_TOKEN"
projenVersion?🔹	`string`	Version of projen to install. *Default*: Defaults to the latest version.
projenrcJs?🔹	`boolean`	Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. *Default*: true if projenrcJson is false
projenrcJsOptions?🔹	`javascript.ProjenrcOptions`	Options for .projenrc.js. *Default*: default options
projenrcJson?🔹	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. *Default*: false
projenrcJsonOptions?🔹	`ProjenrcOptions`	Options for .projenrc.json. *Default*: default options
projenrcTs?🔹	`boolean`	Use TypeScript for your projenrc file (`.projenrc.ts`). *Default*: false
projenrcTsOptions?🔹	`typescript.ProjenrcOptions`	Options for .projenrc.ts. *Optional*
publishDryRun?🔹	`boolean`	Instead of actually publishing to package managers, just print the publishing command. *Default*: false
publishTasks?🔹	`boolean`	Define publishing tasks that can be executed manually as well as workflows. *Default*: false
pullRequestTemplate?🔹	`boolean`	Include a GitHub pull request template. *Default*: true
pullRequestTemplateContents?🔹	`Array`	The contents of the pull request template. *Default*: default content
readme?🔹	`SampleReadmeProps`	The README setup. *Default*: { filename: 'README.md', contents: '# replace this' }
release?🔹	`boolean`	Add release management to this project. *Default*: true (false for subprojects)
releaseBranches?🔹	`Map<string, release.BranchOptions>`	Defines additional release branches. *Default*: no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseEveryCommit?⚠️	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`. *Default*: true
releaseFailureIssue?🔹	`boolean`	Create a github issue on every failed publishing task. *Default*: false
releaseFailureIssueLabel?🔹	`string`	The label to apply to issues indicating publish failures. *Default*: "failed-release"
releaseSchedule?⚠️	`string`	CRON schedule to trigger new releases. *Default*: no scheduled releases
releaseTagPrefix?🔹	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. *Default*: no prefix
releaseToNpm?🔹	`boolean`	Automatically release to npm when new versions are introduced. *Default*: false
releaseTrigger?🔹	`release.ReleaseTrigger`	The release trigger to use. *Default*: Continuous releases (`ReleaseTrigger.continuous()`)
releaseWorkflow?⚠️	`boolean`	DEPRECATED: renamed to `release`. *Default*: true if not a subproject
releaseWorkflowName?🔹	`string`	The name of the default release workflow. *Default*: "Release"
releaseWorkflowSetupSteps?🔹	`Array<github.workflows.JobStep>`	A set of workflow steps to execute in order to setup the workflow container. *Optional*
repository?🔹	`string`	The repository is the location where the actual code for your package lives. *Optional*
repositoryDirectory?🔹	`string`	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. *Optional*
requireApproval?🔹	`awscdk.ApprovalLevel`	To protect you against unintended changes that affect your security posture, the AWS CDK Toolkit prompts you to approve security-related changes before deploying them. *Default*: ApprovalLevel.BROADENING
sampleCode?🔹	`boolean`	Generate one-time sample in `src/` and `test/` if there are no files there. *Default*: true
scopedPackagesOptions?🔹	`Array<javascript.ScopedPackagesOptions>`	Options for privately hosted scoped packages. *Default*: fetch all scoped packages from the public npm registry
scripts?🔹	`Map<string, string>`	npm scripts to include. *Default*: {}
sops?	`SopsAspectOptions`	Enable storing secrets using Mozilla SOPS. *Default*: no SOPS config
srcdir?🔹	`string`	Typescript sources directory. *Default*: "src"
stability?🔹	`string`	Package's Stability. *Optional*
stale?🔹	`boolean`	Auto-close of stale issues and pull request. *Default*: false
staleOptions?🔹	`github.StaleOptions`	Auto-close stale issues and pull requests. *Default*: see defaults in `StaleOptions`
testdir?🔹	`string`	Jest tests directory. Tests files should be named `xxx.test.ts`. *Default*: "test"
tsconfig?🔹	`javascript.TypescriptConfigOptions`	Custom TSConfig. *Default*: default options
tsconfigDev?🔹	`javascript.TypescriptConfigOptions`	Custom tsconfig options for the development tsconfig.json file (used for testing). *Default*: use the production tsconfig options
tsconfigDevFile?🔹	`string`	The name of the development tsconfig.json file. *Default*: "tsconfig.dev.json"
typescriptVersion?🔹	`string`	TypeScript version to use. *Default*: "latest"
versionrcOptions?🔹	`Map<string, any>`	Custom configuration used when creating changelog with standard-version package. *Default*: standard configuration applicable for GitHub repositories
vscode?🔹	`boolean`	Enable VSCode integration. *Default*: true
watchExcludes?🔹	`Array`	Glob patterns to exclude from `cdk watch`. *Default*: []
watchIncludes?🔹	`Array`	Glob patterns to include in `cdk watch`. *Default*: []
workflowBootstrapSteps?🔹	`Array<github.workflows.JobStep>`	Workflow steps to use in order to bootstrap this repo. *Default*: "yarn install --frozen-lockfile && yarn projen"
workflowContainerImage?🔹	`string`	Container image to use for GitHub workflows. *Default*: default image
workflowGitIdentity?🔹	`github.GitIdentity`	The git identity to use in workflows. *Default*: GitHub Actions
workflowNodeVersion?🔹	`string`	The node version to use in GitHub workflows. *Default*: same as `minNodeVersion`
workflowRunsOn?🔹	`Array`	Github Runner selection labels. *Default*: ["ubuntu-latest"]

struct TaimosCdkConstructLibraryOptions

Name	Type	Description
author🔹	`string`	The name of the library author.
authorAddress🔹	`string`	Email or URL of the library author.
cdkVersion🔹	`string`	Minimum version of the AWS CDK to depend on.
defaultReleaseBranch🔹	`string`	The name of the main release branch.
name🔹	`string`	This is the name of your project.
repositoryUrl🔹	`string`	Git repository URL.
allowLibraryDependencies?🔹	`boolean`	Allow the project to include `peerDependencies` and `bundledDependencies`. *Default*: true
artifactsDirectory?🔹	`string`	A directory which will contain build artifacts. *Default*: "dist"
authorEmail?🔹	`string`	Author's e-mail. *Optional*
authorName?🔹	`string`	Author's name. *Optional*
authorOrganization?🔹	`boolean`	Author's Organization. *Optional*
authorUrl?🔹	`string`	Author's URL / Website. *Optional*
autoApproveOptions?🔹	`github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow. *Default*: auto approve is disabled
autoApproveUpgrades?🔹	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). *Default*: true
autoDetectBin?🔹	`boolean`	Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. *Default*: true
autoMerge?🔹	`boolean`	Enable automatic merging on GitHub. *Default*: true
autoMergeOptions?🔹	`github.AutoMergeOptions`	Configure options for automatic merging on GitHub. *Default*: see defaults in `AutoMergeOptions`
bin?🔹	`Map<string, string>`	Binary programs vended with your module. *Optional*
bugsEmail?🔹	`string`	The email address to which issues should be reported. *Optional*
bugsUrl?🔹	`string`	The url to your project's issue tracker. *Optional*
buildWorkflow?🔹	`boolean`	Define a GitHub workflow for building PRs. *Default*: true if not a subproject
buildWorkflowTriggers?🔹	`github.workflows.Triggers`	Build workflow triggers. *Default*: "{ pullRequest: {}, workflowDispatch: {} }"
bundledDeps?🔹	`Array`	List of dependencies to bundle into this module. *Optional*
bundlerOptions?🔹	`javascript.BundlerOptions`	Options for `Bundler`. *Optional*
catalog?🔹	`cdk.Catalog`	Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:. *Default*: new version will be announced
cdkAssert?⚠️	`boolean`	Warning: NodeJS only. *Default*: will be included by default for AWS CDK >= 1.0.0 < 2.0.0
cdkAssertions?🔹	`boolean`	Install the assertions library? *Default*: will be included by default for AWS CDK >= 1.111.0 < 2.0.0
cdkDependencies?⚠️	`Array`	Which AWS CDKv1 modules this project requires. *Optional*
cdkDependenciesAsDeps?⚠️	`boolean`	If this is enabled (default), all modules declared in `cdkDependencies` will be also added as normal `dependencies` (as well as `peerDependencies`). *Default*: true
cdkTestDependencies?⚠️	`Array`	AWS CDK modules required for testing. *Optional*
cdkVersionPinning?🔹	`boolean`	Use pinned version instead of caret version for CDK. *Optional*
clobber?🔹	`boolean`	Add a `clobber` task which resets the repo to origin. *Default*: true
codeArtifactOptions?🔹	`javascript.CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact. *Default*: undefined
codeCov?🔹	`boolean`	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. *Default*: false
codeCovTokenSecret?🔹	`string`	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. *Default*: if this option is not specified, only public repositories are supported
compat?🔹	`boolean`	Automatically run API compatibility test against the latest version published to npm after compilation. *Default*: false
compatIgnore?🔹	`string`	Name of the ignore file for API compatibility tests. *Default*: ".compatignore"
constructsVersion?🔹	`string`	Minimum version of the `constructs` library to depend on. *Default*: for CDK 1.x the default is "3.2.27", for CDK 2.x the default is "10.0.5".
copyrightOwner?🔹	`string`	License copyright owner. *Default*: defaults to the value of authorName or "" if `authorName` is undefined.
copyrightPeriod?🔹	`string`	The copyright years to put in the LICENSE file. *Default*: current year
dependabot?🔹	`boolean`	Use dependabot to handle dependency upgrades. *Default*: false
dependabotOptions?🔹	`github.DependabotOptions`	Options for dependabot. *Default*: default options
deps?🔹	`Array`	Runtime dependencies of this module. *Default*: []
depsUpgrade?🔹	`boolean`	Use github workflows to handle dependency upgrades. *Default*: true
depsUpgradeOptions?🔹	`javascript.UpgradeDependenciesOptions`	Options for `UpgradeDependencies`. *Default*: default options
description?🔹	`string`	The description is just a string that helps people understand the purpose of the package. *Optional*
devContainer?🔹	`boolean`	Add a VSCode development environment (used for GitHub Codespaces). *Default*: false
devDeps?🔹	`Array`	Build dependencies for this module. *Default*: []
disableTsconfig?🔹	`boolean`	Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). *Default*: false
docgen?🔹	`boolean`	Docgen by Typedoc. *Default*: false
docgenFilePath?🔹	`string`	File path for generated docs. *Default*: "API.md"
docsDirectory?🔹	`string`	Docs directory. *Default*: "docs"
dotnet?⚠️	`cdk.JsiiDotNetTarget`	*Optional*
entrypoint?🔹	`string`	Module entrypoint (`main` in `package.json`). *Default*: "lib/index.js"
entrypointTypes?🔹	`string`	The .d.ts file that includes the type declarations for this module. *Default*: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
eslint?🔹	`boolean`	Setup eslint. *Default*: true
eslintOptions?🔹	`javascript.EslintOptions`	Eslint options. *Default*: opinionated default options
excludeTypescript?🔹	`Array`	Accepts a list of glob patterns. *Optional*
github?🔹	`boolean`	Enable GitHub integration. *Default*: true
githubOptions?🔹	`github.GitHubOptions`	Options for GitHub integration. *Default*: see GitHubOptions
gitignore?🔹	`Array`	Additional entries to .gitignore. *Optional*
gitpod?🔹	`boolean`	Add a Gitpod development environment. *Default*: false
homepage?🔹	`string`	Package's Homepage / Website. *Optional*
integrationTestAutoDiscover?🔹	`boolean`	Automatically discovers and creates integration tests for each `.integ.ts` file in under your test directory. *Default*: true
jest?🔹	`boolean`	Setup jest unit tests. *Default*: true
jestOptions?🔹	`javascript.JestOptions`	Jest options. *Default*: default options
jsiiReleaseVersion?🔹	`string`	Version requirement of `publib` which is used to publish modules to npm. *Default*: "latest"
keywords?🔹	`Array`	Keywords to include in `package.json`. *Optional*
lambdaAutoDiscover?🔹	`boolean`	Automatically adds an `aws_lambda.Function` for each `.lambda.ts` handler in your source tree. If this is disabled, you either need to explicitly call `aws_lambda.Function.autoDiscover()` or define a `new aws_lambda.Function()` for each handler. *Default*: true
lambdaExtensionAutoDiscover?🔹	`boolean`	Automatically adds an `awscdk.LambdaExtension` for each `.lambda-extension.ts` entrypoint in your source tree. If this is disabled, you can manually add an `awscdk.AutoDiscover` component to your project. *Default*: true
lambdaOptions?🔹	`awscdk.LambdaFunctionCommonOptions`	Common options for all AWS Lambda functions. *Default*: default options
libdir?🔹	`string`	Typescript artifacts output directory. *Default*: "lib"
license?🔹	`string`	License's SPDX identifier. *Default*: "Apache-2.0"
licensed?🔹	`boolean`	Indicates if a license should be added. *Default*: true
logging?🔹	`LoggerOptions`	Configure logging options such as verbosity. *Default*: {}
majorVersion?🔹	`number`	Major version to release from the default branch. *Default*: Major version is not enforced.
maxNodeVersion?🔹	`string`	Minimum node.js version to require via `engines` (inclusive). *Default*: no max
mergify?⚠️	`boolean`	Whether mergify should be enabled on this repository or not. *Default*: true
mergifyOptions?⚠️	`github.MergifyOptions`	Options for mergify. *Default*: default options
minNodeVersion?🔹	`string`	Minimum Node.js version to require via package.json `engines` (inclusive). *Default*: no "engines" specified
mutableBuild?🔹	`boolean`	Automatically update files modified during builds to pull-request branches. *Default*: true
npmAccess?🔹	`javascript.NpmAccess`	Access level of the npm package. *Default*: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmDistTag?🔹	`string`	The npmDistTag to use when publishing from the default branch. *Default*: "latest"
npmRegistry?⚠️	`string`	The host name of the npm registry to publish to. *Optional*
npmRegistryUrl?🔹	`string`	The base URL of the npm package registry. *Default*: "https://registry.npmjs.org"
npmTokenSecret?🔹	`string`	GitHub secret which contains the NPM token to use when publishing packages. *Default*: "NPM_TOKEN"
npmignore?⚠️	`Array`	Additional entries to .npmignore. *Optional*
npmignoreEnabled?🔹	`boolean`	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. *Default*: true
outdir?🔹	`string`	The root directory of the project. *Default*: "."
package?🔹	`boolean`	Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). *Default*: true
packageManager?🔹	`javascript.NodePackageManager`	The Node Package Manager used to execute scripts. *Default*: NodePackageManager.YARN
packageName?🔹	`string`	The "name" in package.json. *Default*: defaults to project name
parent?🔹	`Project`	The parent project, if this project is part of a bigger project. *Optional*
peerDependencyOptions?🔹	`javascript.PeerDependencyOptions`	Options for `peerDeps`. *Optional*
peerDeps?🔹	`Array`	Peer dependencies for this module. *Default*: []
postBuildSteps?🔹	`Array<github.workflows.JobStep>`	Steps to execute after build as part of the release workflow. *Default*: []
prerelease?🔹	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). *Default*: normal semantic versions
prettier?🔹	`boolean`	Setup prettier. *Default*: false
prettierOptions?🔹	`javascript.PrettierOptions`	Prettier options. *Default*: default options
projectType?⚠️	`ProjectType`	Which type of project this is (library/app). *Default*: ProjectType.UNKNOWN
projenCommand?🔹	`string`	The shell command to use in order to run the projen CLI. *Default*: "npx projen"
projenCredentials?🔹	`github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows. *Default*: use a personal access token named PROJEN_GITHUB_TOKEN
projenDevDependency?🔹	`boolean`	Indicates of "projen" should be installed as a devDependency. *Default*: true
projenTokenSecret?⚠️	`string`	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. *Default*: "PROJEN_GITHUB_TOKEN"
projenVersion?🔹	`string`	Version of projen to install. *Default*: Defaults to the latest version.
projenrcJs?🔹	`boolean`	Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. *Default*: true if projenrcJson is false
projenrcJsOptions?🔹	`javascript.ProjenrcOptions`	Options for .projenrc.js. *Default*: default options
projenrcJson?🔹	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. *Default*: false
projenrcJsonOptions?🔹	`ProjenrcOptions`	Options for .projenrc.json. *Default*: default options
projenrcTs?🔹	`boolean`	Use TypeScript for your projenrc file (`.projenrc.ts`). *Default*: false
projenrcTsOptions?🔹	`typescript.ProjenrcOptions`	Options for .projenrc.ts. *Optional*
publishDryRun?🔹	`boolean`	Instead of actually publishing to package managers, just print the publishing command. *Default*: false
publishTasks?🔹	`boolean`	Define publishing tasks that can be executed manually as well as workflows. *Default*: false
publishToGo?🔹	`cdk.JsiiGoTarget`	Publish Go bindings to a git repository. *Default*: no publishing
publishToMaven?🔹	`cdk.JsiiJavaTarget`	Publish to maven. *Default*: no publishing
publishToNuget?🔹	`cdk.JsiiDotNetTarget`	Publish to NuGet. *Default*: no publishing
publishToPypi?🔹	`cdk.JsiiPythonTarget`	Publish to pypi. *Default*: no publishing
pullRequestTemplate?🔹	`boolean`	Include a GitHub pull request template. *Default*: true
pullRequestTemplateContents?🔹	`Array`	The contents of the pull request template. *Default*: default content
python?⚠️	`cdk.JsiiPythonTarget`	*Optional*
readme?🔹	`SampleReadmeProps`	The README setup. *Default*: { filename: 'README.md', contents: '# replace this' }
release?🔹	`boolean`	Add release management to this project. *Default*: true (false for subprojects)
releaseBranches?🔹	`Map<string, release.BranchOptions>`	Defines additional release branches. *Default*: no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseEveryCommit?⚠️	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`. *Default*: true
releaseFailureIssue?🔹	`boolean`	Create a github issue on every failed publishing task. *Default*: false
releaseFailureIssueLabel?🔹	`string`	The label to apply to issues indicating publish failures. *Default*: "failed-release"
releaseSchedule?⚠️	`string`	CRON schedule to trigger new releases. *Default*: no scheduled releases
releaseTagPrefix?🔹	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. *Default*: no prefix
releaseToNpm?🔹	`boolean`	Automatically release to npm when new versions are introduced. *Default*: false
releaseTrigger?🔹	`release.ReleaseTrigger`	The release trigger to use. *Default*: Continuous releases (`ReleaseTrigger.continuous()`)
releaseWorkflow?⚠️	`boolean`	DEPRECATED: renamed to `release`. *Default*: true if not a subproject
releaseWorkflowName?🔹	`string`	The name of the default release workflow. *Default*: "Release"
releaseWorkflowSetupSteps?🔹	`Array<github.workflows.JobStep>`	A set of workflow steps to execute in order to setup the workflow container. *Optional*
repository?🔹	`string`	The repository is the location where the actual code for your package lives. *Optional*
repositoryDirectory?🔹	`string`	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. *Optional*
rootdir?🔹	`string`	*Default*: "."
sampleCode?🔹	`boolean`	Generate one-time sample in `src/` and `test/` if there are no files there. *Default*: true
scopedPackagesOptions?🔹	`Array<javascript.ScopedPackagesOptions>`	Options for privately hosted scoped packages. *Default*: fetch all scoped packages from the public npm registry
scripts?🔹	`Map<string, string>`	npm scripts to include. *Default*: {}
srcdir?🔹	`string`	Typescript sources directory. *Default*: "src"
stability?🔹	`string`	Package's Stability. *Optional*
stale?🔹	`boolean`	Auto-close of stale issues and pull request. *Default*: false
staleOptions?🔹	`github.StaleOptions`	Auto-close stale issues and pull requests. *Default*: see defaults in `StaleOptions`
testdir?🔹	`string`	Jest tests directory. Tests files should be named `xxx.test.ts`. *Default*: "test"
tsconfig?🔹	`javascript.TypescriptConfigOptions`	Custom TSConfig. *Default*: default options
tsconfigDev?🔹	`javascript.TypescriptConfigOptions`	Custom tsconfig options for the development tsconfig.json file (used for testing). *Default*: use the production tsconfig options
tsconfigDevFile?🔹	`string`	The name of the development tsconfig.json file. *Default*: "tsconfig.dev.json"
typescriptVersion?🔹	`string`	TypeScript version to use. *Default*: "latest"
versionrcOptions?🔹	`Map<string, any>`	Custom configuration used when creating changelog with standard-version package. *Default*: standard configuration applicable for GitHub repositories
vscode?🔹	`boolean`	Enable VSCode integration. *Default*: true
workflowBootstrapSteps?🔹	`Array<github.workflows.JobStep>`	Workflow steps to use in order to bootstrap this repo. *Default*: "yarn install --frozen-lockfile && yarn projen"
workflowContainerImage?🔹	`string`	Container image to use for GitHub workflows. *Default*: default image
workflowGitIdentity?🔹	`github.GitIdentity`	The git identity to use in workflows. *Default*: GitHub Actions
workflowNodeVersion?🔹	`string`	The node version to use in GitHub workflows. *Default*: same as `minNodeVersion`
workflowRunsOn?🔹	`Array`	Github Runner selection labels. *Default*: ["ubuntu-latest"]

struct TaimosPrivateTypescriptLibraryOptions

Name	Type	Description
defaultReleaseBranch🔹	`string`	The name of the main release branch.
name🔹	`string`	This is the name of your project.
allowLibraryDependencies?🔹	`boolean`	Allow the project to include `peerDependencies` and `bundledDependencies`. *Default*: true
artifactsDirectory?🔹	`string`	A directory which will contain build artifacts. *Default*: "dist"
authorEmail?🔹	`string`	Author's e-mail. *Optional*
authorName?🔹	`string`	Author's name. *Optional*
authorOrganization?🔹	`boolean`	Author's Organization. *Optional*
authorUrl?🔹	`string`	Author's URL / Website. *Optional*
autoApproveOptions?🔹	`github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow. *Default*: auto approve is disabled
autoApproveUpgrades?🔹	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). *Default*: true
autoDetectBin?🔹	`boolean`	Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. *Default*: true
autoMerge?🔹	`boolean`	Enable automatic merging on GitHub. *Default*: true
autoMergeOptions?🔹	`github.AutoMergeOptions`	Configure options for automatic merging on GitHub. *Default*: see defaults in `AutoMergeOptions`
bin?🔹	`Map<string, string>`	Binary programs vended with your module. *Optional*
bugsEmail?🔹	`string`	The email address to which issues should be reported. *Optional*
bugsUrl?🔹	`string`	The url to your project's issue tracker. *Optional*
buildWorkflow?🔹	`boolean`	Define a GitHub workflow for building PRs. *Default*: true if not a subproject
buildWorkflowTriggers?🔹	`github.workflows.Triggers`	Build workflow triggers. *Default*: "{ pullRequest: {}, workflowDispatch: {} }"
bundledDeps?🔹	`Array`	List of dependencies to bundle into this module. *Optional*
bundlerOptions?🔹	`javascript.BundlerOptions`	Options for `Bundler`. *Optional*
clobber?🔹	`boolean`	Add a `clobber` task which resets the repo to origin. *Default*: true
codeArtifactOptions?🔹	`javascript.CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact. *Default*: undefined
codeCov?🔹	`boolean`	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. *Default*: false
codeCovTokenSecret?🔹	`string`	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. *Default*: if this option is not specified, only public repositories are supported
copyrightOwner?🔹	`string`	License copyright owner. *Default*: defaults to the value of authorName or "" if `authorName` is undefined.
copyrightPeriod?🔹	`string`	The copyright years to put in the LICENSE file. *Default*: current year
dependabot?🔹	`boolean`	Use dependabot to handle dependency upgrades. *Default*: false
dependabotOptions?🔹	`github.DependabotOptions`	Options for dependabot. *Default*: default options
deps?🔹	`Array`	Runtime dependencies of this module. *Default*: []
depsUpgrade?🔹	`boolean`	Use github workflows to handle dependency upgrades. *Default*: true
depsUpgradeOptions?🔹	`javascript.UpgradeDependenciesOptions`	Options for `UpgradeDependencies`. *Default*: default options
description?🔹	`string`	The description is just a string that helps people understand the purpose of the package. *Optional*
devContainer?🔹	`boolean`	Add a VSCode development environment (used for GitHub Codespaces). *Default*: false
devDeps?🔹	`Array`	Build dependencies for this module. *Default*: []
disableTsconfig?🔹	`boolean`	Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). *Default*: false
docgen?🔹	`boolean`	Docgen by Typedoc. *Default*: false
docsDirectory?🔹	`string`	Docs directory. *Default*: "docs"
entrypoint?🔹	`string`	Module entrypoint (`main` in `package.json`). *Default*: "lib/index.js"
entrypointTypes?🔹	`string`	The .d.ts file that includes the type declarations for this module. *Default*: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
eslint?🔹	`boolean`	Setup eslint. *Default*: true
eslintOptions?🔹	`javascript.EslintOptions`	Eslint options. *Default*: opinionated default options
github?🔹	`boolean`	Enable GitHub integration. *Default*: true
githubOptions?🔹	`github.GitHubOptions`	Options for GitHub integration. *Default*: see GitHubOptions
gitignore?🔹	`Array`	Additional entries to .gitignore. *Optional*
gitpod?🔹	`boolean`	Add a Gitpod development environment. *Default*: false
homepage?🔹	`string`	Package's Homepage / Website. *Optional*
jest?🔹	`boolean`	Setup jest unit tests. *Default*: true
jestOptions?🔹	`javascript.JestOptions`	Jest options. *Default*: default options
jsiiReleaseVersion?🔹	`string`	Version requirement of `publib` which is used to publish modules to npm. *Default*: "latest"
keywords?🔹	`Array`	Keywords to include in `package.json`. *Optional*
libdir?🔹	`string`	Typescript artifacts output directory. *Default*: "lib"
license?🔹	`string`	License's SPDX identifier. *Default*: "Apache-2.0"
licensed?🔹	`boolean`	Indicates if a license should be added. *Default*: true
logging?🔹	`LoggerOptions`	Configure logging options such as verbosity. *Default*: {}
majorVersion?🔹	`number`	Major version to release from the default branch. *Default*: Major version is not enforced.
maxNodeVersion?🔹	`string`	Minimum node.js version to require via `engines` (inclusive). *Default*: no max
mergify?⚠️	`boolean`	Whether mergify should be enabled on this repository or not. *Default*: true
mergifyOptions?⚠️	`github.MergifyOptions`	Options for mergify. *Default*: default options
minNodeVersion?🔹	`string`	Minimum Node.js version to require via package.json `engines` (inclusive). *Default*: no "engines" specified
mutableBuild?🔹	`boolean`	Automatically update files modified during builds to pull-request branches. *Default*: true
npmAccess?🔹	`javascript.NpmAccess`	Access level of the npm package. *Default*: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmDistTag?🔹	`string`	The npmDistTag to use when publishing from the default branch. *Default*: "latest"
npmRegistry?⚠️	`string`	The host name of the npm registry to publish to. *Optional*
npmRegistryUrl?🔹	`string`	The base URL of the npm package registry. *Default*: "https://registry.npmjs.org"
npmTokenSecret?🔹	`string`	GitHub secret which contains the NPM token to use when publishing packages. *Default*: "NPM_TOKEN"
npmignore?⚠️	`Array`	Additional entries to .npmignore. *Optional*
npmignoreEnabled?🔹	`boolean`	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. *Default*: true
outdir?🔹	`string`	The root directory of the project. *Default*: "."
package?🔹	`boolean`	Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). *Default*: true
packageManager?🔹	`javascript.NodePackageManager`	The Node Package Manager used to execute scripts. *Default*: NodePackageManager.YARN
packageName?🔹	`string`	The "name" in package.json. *Default*: defaults to project name
parent?🔹	`Project`	The parent project, if this project is part of a bigger project. *Optional*
peerDependencyOptions?🔹	`javascript.PeerDependencyOptions`	Options for `peerDeps`. *Optional*
peerDeps?🔹	`Array`	Peer dependencies for this module. *Default*: []
postBuildSteps?🔹	`Array<github.workflows.JobStep>`	Steps to execute after build as part of the release workflow. *Default*: []
prerelease?🔹	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). *Default*: normal semantic versions
prettier?🔹	`boolean`	Setup prettier. *Default*: false
prettierOptions?🔹	`javascript.PrettierOptions`	Prettier options. *Default*: default options
projectType?⚠️	`ProjectType`	Which type of project this is (library/app). *Default*: ProjectType.UNKNOWN
projenCommand?🔹	`string`	The shell command to use in order to run the projen CLI. *Default*: "npx projen"
projenCredentials?🔹	`github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows. *Default*: use a personal access token named PROJEN_GITHUB_TOKEN
projenDevDependency?🔹	`boolean`	Indicates of "projen" should be installed as a devDependency. *Default*: true
projenTokenSecret?⚠️	`string`	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. *Default*: "PROJEN_GITHUB_TOKEN"
projenVersion?🔹	`string`	Version of projen to install. *Default*: Defaults to the latest version.
projenrcJs?🔹	`boolean`	Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. *Default*: true if projenrcJson is false
projenrcJsOptions?🔹	`javascript.ProjenrcOptions`	Options for .projenrc.js. *Default*: default options
projenrcJson?🔹	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. *Default*: false
projenrcJsonOptions?🔹	`ProjenrcOptions`	Options for .projenrc.json. *Default*: default options
projenrcTs?🔹	`boolean`	Use TypeScript for your projenrc file (`.projenrc.ts`). *Default*: false
projenrcTsOptions?🔹	`typescript.ProjenrcOptions`	Options for .projenrc.ts. *Optional*
publishDryRun?🔹	`boolean`	Instead of actually publishing to package managers, just print the publishing command. *Default*: false
publishTasks?🔹	`boolean`	Define publishing tasks that can be executed manually as well as workflows. *Default*: false
pullRequestTemplate?🔹	`boolean`	Include a GitHub pull request template. *Default*: true
pullRequestTemplateContents?🔹	`Array`	The contents of the pull request template. *Default*: default content
readme?🔹	`SampleReadmeProps`	The README setup. *Default*: { filename: 'README.md', contents: '# replace this' }
release?🔹	`boolean`	Add release management to this project. *Default*: true (false for subprojects)
releaseBranches?🔹	`Map<string, release.BranchOptions>`	Defines additional release branches. *Default*: no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseEveryCommit?⚠️	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`. *Default*: true
releaseFailureIssue?🔹	`boolean`	Create a github issue on every failed publishing task. *Default*: false
releaseFailureIssueLabel?🔹	`string`	The label to apply to issues indicating publish failures. *Default*: "failed-release"
releaseSchedule?⚠️	`string`	CRON schedule to trigger new releases. *Default*: no scheduled releases
releaseTagPrefix?🔹	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. *Default*: no prefix
releaseToNpm?🔹	`boolean`	Automatically release to npm when new versions are introduced. *Default*: false
releaseTrigger?🔹	`release.ReleaseTrigger`	The release trigger to use. *Default*: Continuous releases (`ReleaseTrigger.continuous()`)
releaseWorkflow?⚠️	`boolean`	DEPRECATED: renamed to `release`. *Default*: true if not a subproject
releaseWorkflowName?🔹	`string`	The name of the default release workflow. *Default*: "Release"
releaseWorkflowSetupSteps?🔹	`Array<github.workflows.JobStep>`	A set of workflow steps to execute in order to setup the workflow container. *Optional*
repository?🔹	`string`	The repository is the location where the actual code for your package lives. *Optional*
repositoryDirectory?🔹	`string`	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. *Optional*
sampleCode?🔹	`boolean`	Generate one-time sample in `src/` and `test/` if there are no files there. *Default*: true
scopedPackagesOptions?🔹	`Array<javascript.ScopedPackagesOptions>`	Options for privately hosted scoped packages. *Default*: fetch all scoped packages from the public npm registry
scripts?🔹	`Map<string, string>`	npm scripts to include. *Default*: {}
srcdir?🔹	`string`	Typescript sources directory. *Default*: "src"
stability?🔹	`string`	Package's Stability. *Optional*
stale?🔹	`boolean`	Auto-close of stale issues and pull request. *Default*: false
staleOptions?🔹	`github.StaleOptions`	Auto-close stale issues and pull requests. *Default*: see defaults in `StaleOptions`
testdir?🔹	`string`	Jest tests directory. Tests files should be named `xxx.test.ts`. *Default*: "test"
tsconfig?🔹	`javascript.TypescriptConfigOptions`	Custom TSConfig. *Default*: default options
tsconfigDev?🔹	`javascript.TypescriptConfigOptions`	Custom tsconfig options for the development tsconfig.json file (used for testing). *Default*: use the production tsconfig options
tsconfigDevFile?🔹	`string`	The name of the development tsconfig.json file. *Default*: "tsconfig.dev.json"
typescriptVersion?🔹	`string`	TypeScript version to use. *Default*: "latest"
versionrcOptions?🔹	`Map<string, any>`	Custom configuration used when creating changelog with standard-version package. *Default*: standard configuration applicable for GitHub repositories
vscode?🔹	`boolean`	Enable VSCode integration. *Default*: true
workflowBootstrapSteps?🔹	`Array<github.workflows.JobStep>`	Workflow steps to use in order to bootstrap this repo. *Default*: "yarn install --frozen-lockfile && yarn projen"
workflowContainerImage?🔹	`string`	Container image to use for GitHub workflows. *Default*: default image
workflowGitIdentity?🔹	`github.GitIdentity`	The git identity to use in workflows. *Default*: GitHub Actions
workflowNodeVersion?🔹	`string`	The node version to use in GitHub workflows. *Default*: same as `minNodeVersion`
workflowRunsOn?🔹	`Array`	Github Runner selection labels. *Default*: ["ubuntu-latest"]

struct TaimosTypescriptLibraryOptions

Name	Type	Description
defaultReleaseBranch🔹	`string`	The name of the main release branch.
name🔹	`string`	This is the name of your project.
allowLibraryDependencies?🔹	`boolean`	Allow the project to include `peerDependencies` and `bundledDependencies`. *Default*: true
artifactsDirectory?🔹	`string`	A directory which will contain build artifacts. *Default*: "dist"
authorEmail?🔹	`string`	Author's e-mail. *Optional*
authorName?🔹	`string`	Author's name. *Optional*
authorOrganization?🔹	`boolean`	Author's Organization. *Optional*
authorUrl?🔹	`string`	Author's URL / Website. *Optional*
autoApproveOptions?🔹	`github.AutoApproveOptions`	Enable and configure the 'auto approve' workflow. *Default*: auto approve is disabled
autoApproveUpgrades?🔹	`boolean`	Automatically approve deps upgrade PRs, allowing them to be merged by mergify (if configued). *Default*: true
autoDetectBin?🔹	`boolean`	Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section. *Default*: true
autoMerge?🔹	`boolean`	Enable automatic merging on GitHub. *Default*: true
autoMergeOptions?🔹	`github.AutoMergeOptions`	Configure options for automatic merging on GitHub. *Default*: see defaults in `AutoMergeOptions`
bin?🔹	`Map<string, string>`	Binary programs vended with your module. *Optional*
bugsEmail?🔹	`string`	The email address to which issues should be reported. *Optional*
bugsUrl?🔹	`string`	The url to your project's issue tracker. *Optional*
buildWorkflow?🔹	`boolean`	Define a GitHub workflow for building PRs. *Default*: true if not a subproject
buildWorkflowTriggers?🔹	`github.workflows.Triggers`	Build workflow triggers. *Default*: "{ pullRequest: {}, workflowDispatch: {} }"
bundledDeps?🔹	`Array`	List of dependencies to bundle into this module. *Optional*
bundlerOptions?🔹	`javascript.BundlerOptions`	Options for `Bundler`. *Optional*
clobber?🔹	`boolean`	Add a `clobber` task which resets the repo to origin. *Default*: true
codeArtifactOptions?🔹	`javascript.CodeArtifactOptions`	Options for npm packages using AWS CodeArtifact. *Default*: undefined
codeCov?🔹	`boolean`	Define a GitHub workflow step for sending code coverage metrics to https://codecov.io/ Uses codecov/codecov-action@v1 A secret is required for private repos. Configured with @codeCovTokenSecret. *Default*: false
codeCovTokenSecret?🔹	`string`	Define the secret name for a specified https://codecov.io/ token A secret is required to send coverage for private repositories. *Default*: if this option is not specified, only public repositories are supported
copyrightOwner?🔹	`string`	License copyright owner. *Default*: defaults to the value of authorName or "" if `authorName` is undefined.
copyrightPeriod?🔹	`string`	The copyright years to put in the LICENSE file. *Default*: current year
dependabot?🔹	`boolean`	Use dependabot to handle dependency upgrades. *Default*: false
dependabotOptions?🔹	`github.DependabotOptions`	Options for dependabot. *Default*: default options
deps?🔹	`Array`	Runtime dependencies of this module. *Default*: []
depsUpgrade?🔹	`boolean`	Use github workflows to handle dependency upgrades. *Default*: true
depsUpgradeOptions?🔹	`javascript.UpgradeDependenciesOptions`	Options for `UpgradeDependencies`. *Default*: default options
description?🔹	`string`	The description is just a string that helps people understand the purpose of the package. *Optional*
devContainer?🔹	`boolean`	Add a VSCode development environment (used for GitHub Codespaces). *Default*: false
devDeps?🔹	`Array`	Build dependencies for this module. *Default*: []
disableTsconfig?🔹	`boolean`	Do not generate a `tsconfig.json` file (used by jsii projects since tsconfig.json is generated by the jsii compiler). *Default*: false
docgen?🔹	`boolean`	Docgen by Typedoc. *Default*: false
docsDirectory?🔹	`string`	Docs directory. *Default*: "docs"
entrypoint?🔹	`string`	Module entrypoint (`main` in `package.json`). *Default*: "lib/index.js"
entrypointTypes?🔹	`string`	The .d.ts file that includes the type declarations for this module. *Default*: .d.ts file derived from the project's entrypoint (usually lib/index.d.ts)
eslint?🔹	`boolean`	Setup eslint. *Default*: true
eslintOptions?🔹	`javascript.EslintOptions`	Eslint options. *Default*: opinionated default options
github?🔹	`boolean`	Enable GitHub integration. *Default*: true
githubOptions?🔹	`github.GitHubOptions`	Options for GitHub integration. *Default*: see GitHubOptions
gitignore?🔹	`Array`	Additional entries to .gitignore. *Optional*
gitpod?🔹	`boolean`	Add a Gitpod development environment. *Default*: false
homepage?🔹	`string`	Package's Homepage / Website. *Optional*
jest?🔹	`boolean`	Setup jest unit tests. *Default*: true
jestOptions?🔹	`javascript.JestOptions`	Jest options. *Default*: default options
jsiiReleaseVersion?🔹	`string`	Version requirement of `publib` which is used to publish modules to npm. *Default*: "latest"
keywords?🔹	`Array`	Keywords to include in `package.json`. *Optional*
libdir?🔹	`string`	Typescript artifacts output directory. *Default*: "lib"
license?🔹	`string`	License's SPDX identifier. *Default*: "Apache-2.0"
licensed?🔹	`boolean`	Indicates if a license should be added. *Default*: true
logging?🔹	`LoggerOptions`	Configure logging options such as verbosity. *Default*: {}
majorVersion?🔹	`number`	Major version to release from the default branch. *Default*: Major version is not enforced.
maxNodeVersion?🔹	`string`	Minimum node.js version to require via `engines` (inclusive). *Default*: no max
mergify?⚠️	`boolean`	Whether mergify should be enabled on this repository or not. *Default*: true
mergifyOptions?⚠️	`github.MergifyOptions`	Options for mergify. *Default*: default options
minNodeVersion?🔹	`string`	Minimum Node.js version to require via package.json `engines` (inclusive). *Default*: no "engines" specified
mutableBuild?🔹	`boolean`	Automatically update files modified during builds to pull-request branches. *Default*: true
npmAccess?🔹	`javascript.NpmAccess`	Access level of the npm package. *Default*: for scoped packages (e.g. `foo@bar`), the default is `NpmAccess.RESTRICTED`, for non-scoped packages, the default is `NpmAccess.PUBLIC`.
npmDistTag?🔹	`string`	The npmDistTag to use when publishing from the default branch. *Default*: "latest"
npmRegistry?⚠️	`string`	The host name of the npm registry to publish to. *Optional*
npmRegistryUrl?🔹	`string`	The base URL of the npm package registry. *Default*: "https://registry.npmjs.org"
npmTokenSecret?🔹	`string`	GitHub secret which contains the NPM token to use when publishing packages. *Default*: "NPM_TOKEN"
npmignore?⚠️	`Array`	Additional entries to .npmignore. *Optional*
npmignoreEnabled?🔹	`boolean`	Defines an .npmignore file. Normally this is only needed for libraries that are packaged as tarballs. *Default*: true
outdir?🔹	`string`	The root directory of the project. *Default*: "."
package?🔹	`boolean`	Defines a `package` task that will produce an npm tarball under the artifacts directory (e.g. `dist`). *Default*: true
packageManager?🔹	`javascript.NodePackageManager`	The Node Package Manager used to execute scripts. *Default*: NodePackageManager.YARN
packageName?🔹	`string`	The "name" in package.json. *Default*: defaults to project name
parent?🔹	`Project`	The parent project, if this project is part of a bigger project. *Optional*
peerDependencyOptions?🔹	`javascript.PeerDependencyOptions`	Options for `peerDeps`. *Optional*
peerDeps?🔹	`Array`	Peer dependencies for this module. *Default*: []
postBuildSteps?🔹	`Array<github.workflows.JobStep>`	Steps to execute after build as part of the release workflow. *Default*: []
prerelease?🔹	`string`	Bump versions from the default branch as pre-releases (e.g. "beta", "alpha", "pre"). *Default*: normal semantic versions
prettier?🔹	`boolean`	Setup prettier. *Default*: false
prettierOptions?🔹	`javascript.PrettierOptions`	Prettier options. *Default*: default options
projectType?⚠️	`ProjectType`	Which type of project this is (library/app). *Default*: ProjectType.UNKNOWN
projenCommand?🔹	`string`	The shell command to use in order to run the projen CLI. *Default*: "npx projen"
projenCredentials?🔹	`github.GithubCredentials`	Choose a method of providing GitHub API access for projen workflows. *Default*: use a personal access token named PROJEN_GITHUB_TOKEN
projenDevDependency?🔹	`boolean`	Indicates of "projen" should be installed as a devDependency. *Default*: true
projenTokenSecret?⚠️	`string`	The name of a secret which includes a GitHub Personal Access Token to be used by projen workflows. *Default*: "PROJEN_GITHUB_TOKEN"
projenVersion?🔹	`string`	Version of projen to install. *Default*: Defaults to the latest version.
projenrcJs?🔹	`boolean`	Generate (once) .projenrc.js (in JavaScript). Set to `false` in order to disable .projenrc.js generation. *Default*: true if projenrcJson is false
projenrcJsOptions?🔹	`javascript.ProjenrcOptions`	Options for .projenrc.js. *Default*: default options
projenrcJson?🔹	`boolean`	Generate (once) .projenrc.json (in JSON). Set to `false` in order to disable .projenrc.json generation. *Default*: false
projenrcJsonOptions?🔹	`ProjenrcOptions`	Options for .projenrc.json. *Default*: default options
projenrcTs?🔹	`boolean`	Use TypeScript for your projenrc file (`.projenrc.ts`). *Default*: false
projenrcTsOptions?🔹	`typescript.ProjenrcOptions`	Options for .projenrc.ts. *Optional*
publishDryRun?🔹	`boolean`	Instead of actually publishing to package managers, just print the publishing command. *Default*: false
publishTasks?🔹	`boolean`	Define publishing tasks that can be executed manually as well as workflows. *Default*: false
pullRequestTemplate?🔹	`boolean`	Include a GitHub pull request template. *Default*: true
pullRequestTemplateContents?🔹	`Array`	The contents of the pull request template. *Default*: default content
readme?🔹	`SampleReadmeProps`	The README setup. *Default*: { filename: 'README.md', contents: '# replace this' }
release?🔹	`boolean`	Add release management to this project. *Default*: true (false for subprojects)
releaseBranches?🔹	`Map<string, release.BranchOptions>`	Defines additional release branches. *Default*: no additional branches are used for release. you can use `addBranch()` to add additional branches.
releaseEveryCommit?⚠️	`boolean`	Automatically release new versions every commit to one of branches in `releaseBranches`. *Default*: true
releaseFailureIssue?🔹	`boolean`	Create a github issue on every failed publishing task. *Default*: false
releaseFailureIssueLabel?🔹	`string`	The label to apply to issues indicating publish failures. *Default*: "failed-release"
releaseSchedule?⚠️	`string`	CRON schedule to trigger new releases. *Default*: no scheduled releases
releaseTagPrefix?🔹	`string`	Automatically add the given prefix to release tags. Useful if you are releasing on multiple branches with overlapping version numbers. *Default*: no prefix
releaseToNpm?🔹	`boolean`	Automatically release to npm when new versions are introduced. *Default*: false
releaseTrigger?🔹	`release.ReleaseTrigger`	The release trigger to use. *Default*: Continuous releases (`ReleaseTrigger.continuous()`)
releaseWorkflow?⚠️	`boolean`	DEPRECATED: renamed to `release`. *Default*: true if not a subproject
releaseWorkflowName?🔹	`string`	The name of the default release workflow. *Default*: "Release"
releaseWorkflowSetupSteps?🔹	`Array<github.workflows.JobStep>`	A set of workflow steps to execute in order to setup the workflow container. *Optional*
repository?🔹	`string`	The repository is the location where the actual code for your package lives. *Optional*
repositoryDirectory?🔹	`string`	If the package.json for your package is not in the root directory (for example if it is part of a monorepo), you can specify the directory in which it lives. *Optional*
sampleCode?🔹	`boolean`	Generate one-time sample in `src/` and `test/` if there are no files there. *Default*: true
scopedPackagesOptions?🔹	`Array<javascript.ScopedPackagesOptions>`	Options for privately hosted scoped packages. *Default*: fetch all scoped packages from the public npm registry
scripts?🔹	`Map<string, string>`	npm scripts to include. *Default*: {}
srcdir?🔹	`string`	Typescript sources directory. *Default*: "src"
stability?🔹	`string`	Package's Stability. *Optional*
stale?🔹	`boolean`	Auto-close of stale issues and pull request. *Default*: false
staleOptions?🔹	`github.StaleOptions`	Auto-close stale issues and pull requests. *Default*: see defaults in `StaleOptions`
testdir?🔹	`string`	Jest tests directory. Tests files should be named `xxx.test.ts`. *Default*: "test"
tsconfig?🔹	`javascript.TypescriptConfigOptions`	Custom TSConfig. *Default*: default options
tsconfigDev?🔹	`javascript.TypescriptConfigOptions`	Custom tsconfig options for the development tsconfig.json file (used for testing). *Default*: use the production tsconfig options
tsconfigDevFile?🔹	`string`	The name of the development tsconfig.json file. *Default*: "tsconfig.dev.json"
typescriptVersion?🔹	`string`	TypeScript version to use. *Default*: "latest"
versionrcOptions?🔹	`Map<string, any>`	Custom configuration used when creating changelog with standard-version package. *Default*: standard configuration applicable for GitHub repositories
vscode?🔹	`boolean`	Enable VSCode integration. *Default*: true
workflowBootstrapSteps?🔹	`Array<github.workflows.JobStep>`	Workflow steps to use in order to bootstrap this repo. *Default*: "yarn install --frozen-lockfile && yarn projen"
workflowContainerImage?🔹	`string`	Container image to use for GitHub workflows. *Default*: default image
workflowGitIdentity?🔹	`github.GitIdentity`	The git identity to use in workflows. *Default*: GitHub Actions
workflowNodeVersion?🔹	`string`	The node version to use in GitHub workflows. *Default*: same as `minNodeVersion`
workflowRunsOn?🔹	`Array`	Github Runner selection labels. *Default*: ["ubuntu-latest"]

FilesExpand file tree

API.md

Latest commit

History

API.md

File metadata and controls

API Reference

class CdkPipelineAspect

Initializer

class PrivateTaimosCdkApp

Initializer

Properties

class SopsAspect

Initializer

Properties

class TaimosCdkApp

Initializer

class TaimosCdkConstructLibrary

Initializer

class TaimosPrivateTypescriptLibrary

Initializer

Properties

class TaimosTypescriptLibrary

Initializer

struct PrivateTaimosCdkAppOptions

struct SopsAspectOptions

struct TaimosCdkAppOptions

struct TaimosCdkConstructLibraryOptions

struct TaimosPrivateTypescriptLibraryOptions

struct TaimosTypescriptLibraryOptions