# API Reference
## Constructs
### AwsCdkConstructLibrary
#### Initializers
```typescript
import { AwsCdkConstructLibrary } from '@pepperize/projen-awscdk-construct'
new AwsCdkConstructLibrary(options: AwsCdkConstructLibraryOptions)
```
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| options | projen.awscdk.AwsCdkConstructLibraryOptions | *No description.* |
---
##### `options`Required
- *Type:* projen.awscdk.AwsCdkConstructLibraryOptions
---
#### Methods
| **Name** | **Description** |
| --- | --- |
| toString | Returns a string representation of this construct. |
| addExcludeFromCleanup | Exclude the matching files from pre-synth cleanup. |
| addGitIgnore | Adds a .gitignore pattern. |
| addPackageIgnore | Adds patterns to be ignored by npm. |
| addTask | Adds a new task to this project. |
| addTip | Prints a "tip" message during synthesis. |
| annotateGenerated | Marks the provided file(s) as being generated. |
| postSynthesize | Called after all components are synthesized. |
| preSynthesize | Called before all components are synthesized. |
| removeTask | Removes a task from a project. |
| runTaskCommand | Returns the shell command to execute in order to run a task. |
| synth | Synthesize all project files into `outdir`. |
| tryFindFile | Finds a file at the specified relative path within this project and all its subprojects. |
| tryFindJsonFile | Finds a json file by name. |
| tryFindObjectFile | Finds an object file (like JsonFile, YamlFile, etc.) by name. |
| tryRemoveFile | Finds a file at the specified relative path within this project and removes it. |
| addBins | *No description.* |
| addBundledDeps | Defines bundled dependencies. |
| addCompileCommand | DEPRECATED. |
| addDeps | Defines normal dependencies. |
| addDevDeps | Defines development/test dependencies. |
| addFields | Directly set fields in `package.json`. |
| addKeywords | Adds keywords to package.json (deduplicated). |
| addPeerDeps | Defines peer dependencies. |
| addScripts | Replaces the contents of multiple npm package.json scripts. |
| addTestCommand | DEPRECATED. |
| hasScript | Indicates if a script by the name name is defined. |
| removeScript | Removes the npm script (always successful). |
| renderWorkflowSetup | Returns the set of workflow steps which should be executed to bootstrap a workflow. |
| setScript | Replaces the contents of an npm package.json script. |
| addCdkDependencies | Adds dependencies to AWS CDK modules. |
| addCdkTestDependencies | Adds AWS CDK modules as dev dependencies. |
---
##### `toString`
```typescript
public toString(): string
```
Returns a string representation of this construct.
##### `addExcludeFromCleanup`
```typescript
public addExcludeFromCleanup(globs: ...string[]): void
```
Exclude the matching files from pre-synth cleanup.
Can be used when, for example, some
source files include the projen marker and we don't want them to be erased during synth.
###### `globs`Required
- *Type:* ...string[]
The glob patterns to match.
---
##### `addGitIgnore`
```typescript
public addGitIgnore(pattern: string): void
```
Adds a .gitignore pattern.
###### `pattern`Required
- *Type:* string
The glob pattern to ignore.
---
##### `addPackageIgnore`
```typescript
public addPackageIgnore(pattern: string): void
```
Adds patterns to be ignored by npm.
###### `pattern`Required
- *Type:* string
The pattern to ignore.
---
##### `addTask`
```typescript
public addTask(name: string, props?: TaskOptions): Task
```
Adds a new task to this project.
This will fail if the project already has
a task with this name.
###### `name`Required
- *Type:* string
The task name to add.
---
###### `props`Optional
- *Type:* projen.TaskOptions
Task properties.
---
##### ~~`addTip`~~
```typescript
public addTip(message: string): void
```
Prints a "tip" message during synthesis.
###### `message`Required
- *Type:* string
The message.
---
##### `annotateGenerated`
```typescript
public annotateGenerated(glob: string): void
```
Marks the provided file(s) as being generated.
This is achieved using the
github-linguist attributes. Generated files do not count against the
repository statistics and language breakdown.
> [https://github.com/github/linguist/blob/master/docs/overrides.md](https://github.com/github/linguist/blob/master/docs/overrides.md)
###### `glob`Required
- *Type:* string
the glob pattern to match (could be a file path).
---
##### `postSynthesize`
```typescript
public postSynthesize(): void
```
Called after all components are synthesized.
Order is *not* guaranteed.
##### `preSynthesize`
```typescript
public preSynthesize(): void
```
Called before all components are synthesized.
##### `removeTask`
```typescript
public removeTask(name: string): Task
```
Removes a task from a project.
###### `name`Required
- *Type:* string
The name of the task to remove.
---
##### `runTaskCommand`
```typescript
public runTaskCommand(task: Task): string
```
Returns the shell command to execute in order to run a task.
This will
typically be `npx projen TASK`.
###### `task`Required
- *Type:* projen.Task
The task for which the command is required.
---
##### `synth`
```typescript
public synth(): void
```
Synthesize all project files into `outdir`.
1. Call "this.preSynthesize()"
2. Delete all generated files
3. Synthesize all subprojects
4. Synthesize all components of this project
5. Call "postSynthesize()" for all components of this project
6. Call "this.postSynthesize()"
##### `tryFindFile`
```typescript
public tryFindFile(filePath: string): FileBase
```
Finds a file at the specified relative path within this project and all its subprojects.
###### `filePath`Required
- *Type:* string
The file path.
If this path is relative, it will be resolved
from the root of _this_ project.
---
##### ~~`tryFindJsonFile`~~
```typescript
public tryFindJsonFile(filePath: string): JsonFile
```
Finds a json file by name.
###### `filePath`Required
- *Type:* string
The file path.
---
##### `tryFindObjectFile`
```typescript
public tryFindObjectFile(filePath: string): ObjectFile
```
Finds an object file (like JsonFile, YamlFile, etc.) by name.
###### `filePath`Required
- *Type:* string
The file path.
---
##### `tryRemoveFile`
```typescript
public tryRemoveFile(filePath: string): FileBase
```
Finds a file at the specified relative path within this project and removes it.
###### `filePath`Required
- *Type:* string
The file path.
If this path is relative, it will be
resolved from the root of _this_ project.
---
##### `addBins`
```typescript
public addBins(bins: {[ key: string ]: string}): void
```
###### `bins`Required
- *Type:* {[ key: string ]: string}
---
##### `addBundledDeps`
```typescript
public addBundledDeps(deps: ...string[]): void
```
Defines bundled dependencies.
Bundled dependencies will be added as normal dependencies as well as to the
`bundledDependencies` section of your `package.json`.
###### `deps`Required
- *Type:* ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next `npx projen` run and the version will be recorded
in your `package.json` file. You can upgrade manually or using `yarn
add/upgrade`. If you wish to specify a version range use this syntax:
`module@^7`.
---
##### ~~`addCompileCommand`~~
```typescript
public addCompileCommand(commands: ...string[]): void
```
DEPRECATED.
###### `commands`Required
- *Type:* ...string[]
---
##### `addDeps`
```typescript
public addDeps(deps: ...string[]): void
```
Defines normal dependencies.
###### `deps`Required
- *Type:* ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next `npx projen` run and the version will be recorded
in your `package.json` file. You can upgrade manually or using `yarn
add/upgrade`. If you wish to specify a version range use this syntax:
`module@^7`.
---
##### `addDevDeps`
```typescript
public addDevDeps(deps: ...string[]): void
```
Defines development/test dependencies.
###### `deps`Required
- *Type:* ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next `npx projen` run and the version will be recorded
in your `package.json` file. You can upgrade manually or using `yarn
add/upgrade`. If you wish to specify a version range use this syntax:
`module@^7`.
---
##### `addFields`
```typescript
public addFields(fields: {[ key: string ]: any}): void
```
Directly set fields in `package.json`.
###### `fields`Required
- *Type:* {[ key: string ]: any}
The fields to set.
---
##### `addKeywords`
```typescript
public addKeywords(keywords: ...string[]): void
```
Adds keywords to package.json (deduplicated).
###### `keywords`Required
- *Type:* ...string[]
The keywords to add.
---
##### `addPeerDeps`
```typescript
public addPeerDeps(deps: ...string[]): void
```
Defines peer dependencies.
When adding peer dependencies, a devDependency will also be added on the
pinned version of the declared peer. This will ensure that you are testing
your code against the minimum version required from your consumers.
###### `deps`Required
- *Type:* ...string[]
Names modules to install.
By default, the the dependency will
be installed in the next `npx projen` run and the version will be recorded
in your `package.json` file. You can upgrade manually or using `yarn
add/upgrade`. If you wish to specify a version range use this syntax:
`module@^7`.
---
##### `addScripts`
```typescript
public addScripts(scripts: {[ key: string ]: string}): void
```
Replaces the contents of multiple npm package.json scripts.
###### `scripts`Required
- *Type:* {[ key: string ]: string}
The scripts to set.
---
##### ~~`addTestCommand`~~
```typescript
public addTestCommand(commands: ...string[]): void
```
DEPRECATED.
###### `commands`Required
- *Type:* ...string[]
---
##### ~~`hasScript`~~
```typescript
public hasScript(name: string): boolean
```
Indicates if a script by the name name is defined.
###### `name`Required
- *Type:* string
The name of the script.
---
##### `removeScript`
```typescript
public removeScript(name: string): void
```
Removes the npm script (always successful).
###### `name`Required
- *Type:* string
The name of the script.
---
##### `renderWorkflowSetup`
```typescript
public renderWorkflowSetup(options?: RenderWorkflowSetupOptions): JobStep[]
```
Returns the set of workflow steps which should be executed to bootstrap a workflow.
###### `options`Optional
- *Type:* projen.javascript.RenderWorkflowSetupOptions
Options.
---
##### `setScript`
```typescript
public setScript(name: string, command: string): void
```
Replaces the contents of an npm package.json script.
###### `name`Required
- *Type:* string
The script name.
---
###### `command`Required
- *Type:* string
The command to execute.
---
##### ~~`addCdkDependencies`~~
```typescript
public addCdkDependencies(deps: ...string[]): void
```
Adds dependencies to AWS CDK modules.
Since this is a library project, dependencies will be added as peer dependencies.
###### `deps`Required
- *Type:* ...string[]
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
---
##### ~~`addCdkTestDependencies`~~
```typescript
public addCdkTestDependencies(deps: ...string[]): void
```
Adds AWS CDK modules as dev dependencies.
###### `deps`Required
- *Type:* ...string[]
names of cdk modules (e.g. `@aws-cdk/aws-lambda`).
---
#### Static Functions
| **Name** | **Description** |
| --- | --- |
| isConstruct | Checks if `x` is a construct. |
| isProject | Test whether the given construct is a project. |
| of | Find the closest ancestor project for given construct. |
---
##### `isConstruct`
```typescript
import { AwsCdkConstructLibrary } from '@pepperize/projen-awscdk-construct'
AwsCdkConstructLibrary.isConstruct(x: any)
```
Checks if `x` is a construct.
Use this method instead of `instanceof` to properly detect `Construct`
instances, even when the construct library is symlinked.
Explanation: in JavaScript, multiple copies of the `constructs` library on
disk are seen as independent, completely different libraries. As a
consequence, the class `Construct` in each copy of the `constructs` library
is seen as a different class, and an instance of one class will not test as
`instanceof` the other class. `npm install` will not create installations
like this, but users may manually symlink construct libraries together or
use a monorepo tool: in those cases, multiple copies of the `constructs`
library can be accidentally installed, and `instanceof` will behave
unpredictably. It is safest to avoid using `instanceof`, and using
this type-testing method instead.
###### `x`Required
- *Type:* any
Any object.
---
##### `isProject`
```typescript
import { AwsCdkConstructLibrary } from '@pepperize/projen-awscdk-construct'
AwsCdkConstructLibrary.isProject(x: any)
```
Test whether the given construct is a project.
###### `x`Required
- *Type:* any
---
##### `of`
```typescript
import { AwsCdkConstructLibrary } from '@pepperize/projen-awscdk-construct'
AwsCdkConstructLibrary.of(construct: IConstruct)
```
Find the closest ancestor project for given construct.
When given a project, this it the project itself.
###### `construct`Required
- *Type:* constructs.IConstruct
---
#### Properties
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| node | constructs.Node | The tree node. |
| buildTask | projen.Task | *No description.* |
| commitGenerated | boolean | Whether to commit the managed files by default. |
| compileTask | projen.Task | *No description.* |
| components | projen.Component[] | Returns all the components within this project. |
| deps | projen.Dependencies | Project dependencies. |
| ejected | boolean | Whether or not the project is being ejected. |
| files | projen.FileBase[] | All files in this project. |
| gitattributes | projen.GitAttributesFile | The .gitattributes file for this repository. |
| gitignore | projen.IgnoreFile | .gitignore. |
| logger | projen.Logger | Logging utilities. |
| name | string | Project name. |
| outdir | string | Absolute output directory of this project. |
| packageTask | projen.Task | *No description.* |
| postCompileTask | projen.Task | *No description.* |
| preCompileTask | projen.Task | *No description.* |
| projectBuild | projen.ProjectBuild | Manages the build process of the project. |
| projenCommand | string | The command to use in order to run the projen CLI. |
| root | projen.Project | The root project. |
| subprojects | projen.Project[] | Returns all the subprojects within this project. |
| tasks | projen.Tasks | Project tasks. |
| testTask | projen.Task | *No description.* |
| defaultTask | projen.Task | This is the "default" task, the one that executes "projen". |
| initProject | projen.InitProject | The options used when this project is bootstrapped via `projen new`. |
| parent | projen.Project | A parent project. |
| projectType | projen.ProjectType | *No description.* |
| autoApprove | projen.github.AutoApprove | Auto approve set up for this project. |
| devContainer | projen.vscode.DevContainer | Access for .devcontainer.json (used for GitHub Codespaces). |
| github | projen.github.GitHub | Access all github components. |
| gitpod | projen.Gitpod | Access for Gitpod. |
| vscode | projen.vscode.VsCode | Access all VSCode components. |
| allowLibraryDependencies | boolean | *No description.* |
| artifactsDirectory | string | The build output directory. |
| artifactsJavascriptDirectory | string | The location of the npm tarball after build (`${artifactsDirectory}/js`). |
| bundler | projen.javascript.Bundler | *No description.* |
| entrypoint | string | *No description.* |
| manifest | any | *No description.* |
| npmrc | projen.javascript.NpmConfig | The .npmrc file. |
| package | projen.javascript.NodePackage | API for managing the node package. |
| packageManager | projen.javascript.NodePackageManager | The package manager to use. |
| runScriptCommand | string | The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager). |
| autoMerge | projen.github.AutoMerge | Component that sets up mergify for merging approved pull requests. |
| buildWorkflow | projen.build.BuildWorkflow | The PR build GitHub workflow. |
| buildWorkflowJobId | string | The job ID of the build workflow. |
| jest | projen.javascript.Jest | The Jest configuration (if enabled). |
| maxNodeVersion | string | Maximum node version supported by this package. |
| minNodeVersion | string | The minimum node version required by this package to function. |
| npmignore | projen.IgnoreFile | The .npmignore file. |
| prettier | projen.javascript.Prettier | *No description.* |
| publisher | projen.release.Publisher | Package publisher. |
| release | projen.release.Release | Release management. |
| upgradeWorkflow | projen.javascript.UpgradeDependencies | The upgrade workflow. |
| docsDirectory | string | *No description.* |
| libdir | string | The directory in which compiled .js files reside. |
| srcdir | string | The directory in which the .ts sources reside. |
| testdir | string | The directory in which tests reside. |
| tsconfigDev | projen.javascript.TypescriptConfig | A typescript configuration file which covers all files (sources, tests, projen). |
| watchTask | projen.Task | The "watch" task. |
| docgen | boolean | *No description.* |
| eslint | projen.javascript.Eslint | *No description.* |
| tsconfig | projen.javascript.TypescriptConfig | *No description.* |
| tsconfigEslint | projen.javascript.TypescriptConfig | *No description.* |
| cdkDeps | projen.awscdk.AwsCdkDeps | *No description.* |
| cdkVersion | string | The target CDK version for this library. |
| version | string | *No description.* |
| formatTask | projen.Task | The "format" task. |
---
##### `node`Required
```typescript
public readonly node: Node;
```
- *Type:* constructs.Node
The tree node.
---
##### `buildTask`Required
```typescript
public readonly buildTask: Task;
```
- *Type:* projen.Task
---
##### `commitGenerated`Required
```typescript
public readonly commitGenerated: boolean;
```
- *Type:* boolean
Whether to commit the managed files by default.
---
##### `compileTask`Required
```typescript
public readonly compileTask: Task;
```
- *Type:* projen.Task
---
##### `components`Required
```typescript
public readonly components: Component[];
```
- *Type:* projen.Component[]
Returns all the components within this project.
---
##### `deps`Required
```typescript
public readonly deps: Dependencies;
```
- *Type:* projen.Dependencies
Project dependencies.
---
##### `ejected`Required
```typescript
public readonly ejected: boolean;
```
- *Type:* boolean
Whether or not the project is being ejected.
---
##### `files`Required
```typescript
public readonly files: FileBase[];
```
- *Type:* projen.FileBase[]
All files in this project.
---
##### `gitattributes`Required
```typescript
public readonly gitattributes: GitAttributesFile;
```
- *Type:* projen.GitAttributesFile
The .gitattributes file for this repository.
---
##### `gitignore`Required
```typescript
public readonly gitignore: IgnoreFile;
```
- *Type:* projen.IgnoreFile
.gitignore.
---
##### `logger`Required
```typescript
public readonly logger: Logger;
```
- *Type:* projen.Logger
Logging utilities.
---
##### `name`Required
```typescript
public readonly name: string;
```
- *Type:* string
Project name.
---
##### `outdir`Required
```typescript
public readonly outdir: string;
```
- *Type:* string
Absolute output directory of this project.
---
##### `packageTask`Required
```typescript
public readonly packageTask: Task;
```
- *Type:* projen.Task
---
##### `postCompileTask`Required
```typescript
public readonly postCompileTask: Task;
```
- *Type:* projen.Task
---
##### `preCompileTask`Required
```typescript
public readonly preCompileTask: Task;
```
- *Type:* projen.Task
---
##### `projectBuild`Required
```typescript
public readonly projectBuild: ProjectBuild;
```
- *Type:* projen.ProjectBuild
Manages the build process of the project.
---
##### `projenCommand`Required
```typescript
public readonly projenCommand: string;
```
- *Type:* string
The command to use in order to run the projen CLI.
---
##### `root`Required
```typescript
public readonly root: Project;
```
- *Type:* projen.Project
The root project.
---
##### `subprojects`Required
```typescript
public readonly subprojects: Project[];
```
- *Type:* projen.Project[]
Returns all the subprojects within this project.
---
##### `tasks`Required
```typescript
public readonly tasks: Tasks;
```
- *Type:* projen.Tasks
Project tasks.
---
##### `testTask`Required
```typescript
public readonly testTask: Task;
```
- *Type:* projen.Task
---
##### `defaultTask`Optional
```typescript
public readonly defaultTask: Task;
```
- *Type:* projen.Task
This is the "default" task, the one that executes "projen".
Undefined if
the project is being ejected.
---
##### `initProject`Optional
```typescript
public readonly initProject: InitProject;
```
- *Type:* projen.InitProject
The options used when this project is bootstrapped via `projen new`.
It
includes the original set of options passed to the CLI and also the JSII
FQN of the project type.
---
##### `parent`Optional
```typescript
public readonly parent: Project;
```
- *Type:* projen.Project
A parent project.
If undefined, this is the root project.
---
##### `projectType`Required
```typescript
public readonly projectType: ProjectType;
```
- *Type:* projen.ProjectType
---
##### `autoApprove`Optional
```typescript
public readonly autoApprove: AutoApprove;
```
- *Type:* projen.github.AutoApprove
Auto approve set up for this project.
---
##### `devContainer`Optional
```typescript
public readonly devContainer: DevContainer;
```
- *Type:* projen.vscode.DevContainer
Access for .devcontainer.json (used for GitHub Codespaces).
This will be `undefined` if devContainer boolean is false
---
##### `github`Optional
```typescript
public readonly github: GitHub;
```
- *Type:* projen.github.GitHub
Access all github components.
This will be `undefined` for subprojects.
---
##### `gitpod`Optional
```typescript
public readonly gitpod: Gitpod;
```
- *Type:* projen.Gitpod
Access for Gitpod.
This will be `undefined` if gitpod boolean is false
---
##### `vscode`Optional
```typescript
public readonly vscode: VsCode;
```
- *Type:* projen.vscode.VsCode
Access all VSCode components.
This will be `undefined` for subprojects.
---
##### ~~`allowLibraryDependencies`~~Required
- *Deprecated:* use `package.allowLibraryDependencies`
```typescript
public readonly allowLibraryDependencies: boolean;
```
- *Type:* boolean
---
##### `artifactsDirectory`Required
```typescript
public readonly artifactsDirectory: string;
```
- *Type:* string
The build output directory.
An npm tarball will be created under the `js`
subdirectory. For example, if this is set to `dist` (the default), the npm
tarball will be placed under `dist/js/boom-boom-1.2.3.tg`.
---
##### `artifactsJavascriptDirectory`Required
```typescript
public readonly artifactsJavascriptDirectory: string;
```
- *Type:* string
The location of the npm tarball after build (`${artifactsDirectory}/js`).
---
##### `bundler`Required
```typescript
public readonly bundler: Bundler;
```
- *Type:* projen.javascript.Bundler
---
##### ~~`entrypoint`~~Required
- *Deprecated:* use `package.entrypoint`
```typescript
public readonly entrypoint: string;
```
- *Type:* string
---
##### ~~`manifest`~~Required
- *Deprecated:* use `package.addField(x, y)`
```typescript
public readonly manifest: any;
```
- *Type:* any
---
##### `npmrc`Required
```typescript
public readonly npmrc: NpmConfig;
```
- *Type:* projen.javascript.NpmConfig
The .npmrc file.
---
##### `package`Required
```typescript
public readonly package: NodePackage;
```
- *Type:* projen.javascript.NodePackage
API for managing the node package.
---
##### ~~`packageManager`~~Required
- *Deprecated:* use `package.packageManager`
```typescript
public readonly packageManager: NodePackageManager;
```
- *Type:* projen.javascript.NodePackageManager
The package manager to use.
---
##### `runScriptCommand`Required
```typescript
public readonly runScriptCommand: string;
```
- *Type:* string
The command to use to run scripts (e.g. `yarn run` or `npm run` depends on the package manager).
---
##### `autoMerge`Optional
```typescript
public readonly autoMerge: AutoMerge;
```
- *Type:* projen.github.AutoMerge
Component that sets up mergify for merging approved pull requests.
---
##### `buildWorkflow`Optional
```typescript
public readonly buildWorkflow: BuildWorkflow;
```
- *Type:* projen.build.BuildWorkflow
The PR build GitHub workflow.
`undefined` if `buildWorkflow` is disabled.
---
##### `buildWorkflowJobId`Optional
```typescript
public readonly buildWorkflowJobId: string;
```
- *Type:* string
The job ID of the build workflow.
---
##### `jest`Optional
```typescript
public readonly jest: Jest;
```
- *Type:* projen.javascript.Jest
The Jest configuration (if enabled).
---
##### `maxNodeVersion`Optional
```typescript
public readonly maxNodeVersion: string;
```
- *Type:* string
Maximum node version supported by this package.
The value indicates the package is incompatible with newer versions.
---
##### `minNodeVersion`Optional
```typescript
public readonly minNodeVersion: string;
```
- *Type:* string
The minimum node version required by this package to function.
This value indicates the package is incompatible with older versions.
---
##### `npmignore`Optional
```typescript
public readonly npmignore: IgnoreFile;
```
- *Type:* projen.IgnoreFile
The .npmignore file.
---
##### `prettier`Optional
```typescript
public readonly prettier: Prettier;
```
- *Type:* projen.javascript.Prettier
---
##### ~~`publisher`~~Optional
- *Deprecated:* use `release.publisher`.
```typescript
public readonly publisher: Publisher;
```
- *Type:* projen.release.Publisher
Package publisher.
This will be `undefined` if the project does not have a
release workflow.
---
##### `release`Optional
```typescript
public readonly release: Release;
```
- *Type:* projen.release.Release
Release management.
---
##### `upgradeWorkflow`Optional
```typescript
public readonly upgradeWorkflow: UpgradeDependencies;
```
- *Type:* projen.javascript.UpgradeDependencies
The upgrade workflow.
---
##### `docsDirectory`Required
```typescript
public readonly docsDirectory: string;
```
- *Type:* string
---
##### `libdir`Required
```typescript
public readonly libdir: string;
```
- *Type:* string
The directory in which compiled .js files reside.
---
##### `srcdir`Required
```typescript
public readonly srcdir: string;
```
- *Type:* string
The directory in which the .ts sources reside.
---
##### `testdir`Required
```typescript
public readonly testdir: string;
```
- *Type:* string
The directory in which tests reside.
---
##### `tsconfigDev`Required
```typescript
public readonly tsconfigDev: TypescriptConfig;
```
- *Type:* projen.javascript.TypescriptConfig
A typescript configuration file which covers all files (sources, tests, projen).
---
##### `watchTask`Required
```typescript
public readonly watchTask: Task;
```
- *Type:* projen.Task
The "watch" task.
---
##### `docgen`Optional
```typescript
public readonly docgen: boolean;
```
- *Type:* boolean
---
##### `eslint`Optional
```typescript
public readonly eslint: Eslint;
```
- *Type:* projen.javascript.Eslint
---
##### `tsconfig`Optional
```typescript
public readonly tsconfig: TypescriptConfig;
```
- *Type:* projen.javascript.TypescriptConfig
---
##### `tsconfigEslint`Optional
```typescript
public readonly tsconfigEslint: TypescriptConfig;
```
- *Type:* projen.javascript.TypescriptConfig
---
##### `cdkDeps`Required
```typescript
public readonly cdkDeps: AwsCdkDeps;
```
- *Type:* projen.awscdk.AwsCdkDeps
---
##### `cdkVersion`Required
```typescript
public readonly cdkVersion: string;
```
- *Type:* string
The target CDK version for this library.
---
##### ~~`version`~~Required
- *Deprecated:* use `cdkVersion`
```typescript
public readonly version: string;
```
- *Type:* string
---
##### `formatTask`Required
```typescript
public readonly formatTask: Task;
```
- *Type:* projen.Task
The "format" task.
---
#### Constants
| **Name** | **Type** | **Description** |
| --- | --- | --- |
| DEFAULT_TASK | string | The name of the default task (the task executed when `projen` is run without arguments). |
| DEFAULT_TS_JEST_TRANFORM_PATTERN | string | *No description.* |
---
##### `DEFAULT_TASK`Required
```typescript
public readonly DEFAULT_TASK: string;
```
- *Type:* string
The name of the default task (the task executed when `projen` is run without arguments).
Normally
this task should synthesize the project files.
---
##### `DEFAULT_TS_JEST_TRANFORM_PATTERN`Required
```typescript
public readonly DEFAULT_TS_JEST_TRANFORM_PATTERN: string;
```
- *Type:* string
---