| Package | Description |
|---|---|
| io.github.cdklabs.projen.javascript |
| Modifier and Type | Method and Description |
|---|---|
NodePackage.Builder |
NodePackage.Builder.allowLibraryDependencies(Boolean allowLibraryDependencies)
(experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
|
NodePackage.Builder |
NodePackage.Builder.authorEmail(String authorEmail)
(experimental) Author's e-mail.
|
NodePackage.Builder |
NodePackage.Builder.authorName(String authorName)
(experimental) Author's name.
|
NodePackage.Builder |
NodePackage.Builder.authorOrganization(Boolean authorOrganization)
(experimental) Author's Organization.
|
NodePackage.Builder |
NodePackage.Builder.authorUrl(String authorUrl)
(experimental) Author's URL / Website.
|
NodePackage.Builder |
NodePackage.Builder.autoDetectBin(Boolean autoDetectBin)
(experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
|
NodePackage.Builder |
NodePackage.Builder.bin(Map<String,String> bin)
(experimental) Binary programs vended with your module.
|
NodePackage.Builder |
NodePackage.Builder.bundledDeps(List<String> bundledDeps)
(experimental) List of dependencies to bundle into this module.
|
NodePackage.Builder |
NodePackage.Builder.codeArtifactOptions(CodeArtifactOptions codeArtifactOptions)
(experimental) Options for publishing npm package to AWS CodeArtifact.
|
static NodePackage.Builder |
NodePackage.Builder.create(Project project) |
NodePackage.Builder |
NodePackage.Builder.deps(List<String> deps)
(experimental) Runtime dependencies of this module.
|
NodePackage.Builder |
NodePackage.Builder.description(String description)
(experimental) The description is just a string that helps people understand the purpose of the package.
|
NodePackage.Builder |
NodePackage.Builder.devDeps(List<String> devDeps)
(experimental) Build dependencies for this module.
|
NodePackage.Builder |
NodePackage.Builder.entrypoint(String entrypoint)
(experimental) Module entrypoint (`main` in `package.json`).
|
NodePackage.Builder |
NodePackage.Builder.homepage(String homepage)
(experimental) Package's Homepage / Website.
|
NodePackage.Builder |
NodePackage.Builder.keywords(List<String> keywords)
(experimental) Keywords to include in `package.json`.
|
NodePackage.Builder |
NodePackage.Builder.license(String license)
(experimental) License's SPDX identifier.
|
NodePackage.Builder |
NodePackage.Builder.licensed(Boolean licensed)
(experimental) Indicates if a license should be added.
|
NodePackage.Builder |
NodePackage.Builder.maxNodeVersion(String maxNodeVersion)
(experimental) Minimum node.js version to require via `engines` (inclusive).
|
NodePackage.Builder |
NodePackage.Builder.minNodeVersion(String minNodeVersion)
(experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
|
NodePackage.Builder |
NodePackage.Builder.npmAccess(NpmAccess npmAccess)
(experimental) Access level of the npm package.
|
NodePackage.Builder |
NodePackage.Builder.npmRegistry(String npmRegistry)
Deprecated.
use `npmRegistryUrl` instead
|
NodePackage.Builder |
NodePackage.Builder.npmRegistryUrl(String npmRegistryUrl)
(experimental) The base URL of the npm package registry.
|
NodePackage.Builder |
NodePackage.Builder.npmTokenSecret(String npmTokenSecret)
(experimental) GitHub secret which contains the NPM token to use when publishing packages.
|
NodePackage.Builder |
NodePackage.Builder.packageManager(NodePackageManager packageManager)
(experimental) The Node Package Manager used to execute scripts.
|
NodePackage.Builder |
NodePackage.Builder.packageName(String packageName)
(experimental) The "name" in package.json.
|
NodePackage.Builder |
NodePackage.Builder.peerDependencyOptions(PeerDependencyOptions peerDependencyOptions)
(experimental) Options for `peerDeps`.
|
NodePackage.Builder |
NodePackage.Builder.peerDeps(List<String> peerDeps)
(experimental) Peer dependencies for this module.
|
NodePackage.Builder |
NodePackage.Builder.repository(String repository)
(experimental) The repository is the location where the actual code for your package lives.
|
NodePackage.Builder |
NodePackage.Builder.repositoryDirectory(String repositoryDirectory)
(experimental) 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.
|
NodePackage.Builder |
NodePackage.Builder.scripts(Map<String,String> scripts)
(experimental) npm scripts to include.
|
NodePackage.Builder |
NodePackage.Builder.stability(String stability)
(experimental) Package's Stability.
|
Copyright © 2021. All rights reserved.