NodePackageOptions.Jsii$Proxy (io.github.cdklabs:projen 0.45.3 API)

java.lang.Object
- software.amazon.jsii.JsiiObject
- - io.github.cdklabs.projen.javascript.NodePackageOptions.Jsii$Proxy

All Implemented Interfaces:: NodePackageOptions, software.amazon.jsii.JsiiSerializable

Enclosing interface:: NodePackageOptions

@Stability(value=Experimental)
 @Internal
public static final class NodePackageOptions.Jsii$Proxy
extends software.amazon.jsii.JsiiObject
implements NodePackageOptions

An implementation for NodePackageOptions

Nested Class Summary
- Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject
  software.amazon.jsii.JsiiObject.InitializationMode
- Nested classes/interfaces inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions
  NodePackageOptions.Builder, NodePackageOptions.Jsii$Proxy

Constructor Summary

Constructors
Modifier	Constructor and Description
`protected`	`Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)` Constructor that initializes the object based on values retrieved from the JsiiObject.
`protected`	`Jsii$Proxy(NodePackageOptions.Builder builder)` Constructor that initializes the object based on literal property values passed by the `NodePackageOptions.Builder`.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`com.fasterxml.jackson.databind.JsonNode`	`$jsii$toJson()`
`boolean`	`equals(Object o)`
`Boolean`	`getAllowLibraryDependencies()` (experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
`String`	`getAuthorEmail()` (experimental) Author's e-mail.
`String`	`getAuthorName()` (experimental) Author's name.
`Boolean`	`getAuthorOrganization()` (experimental) Author's Organization.
`String`	`getAuthorUrl()` (experimental) Author's URL / Website.
`Boolean`	`getAutoDetectBin()` (experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
`Map<String,String>`	`getBin()` (experimental) Binary programs vended with your module.
`List<String>`	`getBundledDeps()` (experimental) List of dependencies to bundle into this module.
`CodeArtifactOptions`	`getCodeArtifactOptions()` (experimental) Options for publishing npm package to AWS CodeArtifact.
`List<String>`	`getDeps()` (experimental) Runtime dependencies of this module.
`String`	`getDescription()` (experimental) The description is just a string that helps people understand the purpose of the package.
`List<String>`	`getDevDeps()` (experimental) Build dependencies for this module.
`String`	`getEntrypoint()` (experimental) Module entrypoint (`main` in `package.json`).
`String`	`getHomepage()` (experimental) Package's Homepage / Website.
`List<String>`	`getKeywords()` (experimental) Keywords to include in `package.json`.
`String`	`getLicense()` (experimental) License's SPDX identifier.
`Boolean`	`getLicensed()` (experimental) Indicates if a license should be added.
`String`	`getMaxNodeVersion()` (experimental) Minimum node.js version to require via `engines` (inclusive).
`String`	`getMinNodeVersion()` (experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
`NpmAccess`	`getNpmAccess()` (experimental) Access level of the npm package.
`String`	`getNpmRegistry()` (deprecated) The host name of the npm registry to publish to.
`String`	`getNpmRegistryUrl()` (experimental) The base URL of the npm package registry.
`String`	`getNpmTokenSecret()` (experimental) GitHub secret which contains the NPM token to use when publishing packages.
`NodePackageManager`	`getPackageManager()` (experimental) The Node Package Manager used to execute scripts.
`String`	`getPackageName()` (experimental) The "name" in package.json.
`PeerDependencyOptions`	`getPeerDependencyOptions()` (experimental) Options for `peerDeps`.
`List<String>`	`getPeerDeps()` (experimental) Peer dependencies for this module.
`String`	`getRepository()` (experimental) The repository is the location where the actual code for your package lives.
`String`	`getRepositoryDirectory()` (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.
`Map<String,String>`	`getScripts()` (experimental) npm scripts to include.
`String`	`getStability()` (experimental) Package's Stability.
`int`	`hashCode()`

Methods inherited from class software.amazon.jsii.JsiiObject
jsiiAsyncCall, jsiiAsyncCall, jsiiCall, jsiiCall, jsiiGet, jsiiGet, jsiiSet, jsiiStaticCall, jsiiStaticCall, jsiiStaticGet, jsiiStaticGet, jsiiStaticSet, jsiiStaticSet

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions
builder

- Constructor Detail
  - Jsii$Proxy
```
protected Jsii$Proxy(software.amazon.jsii.JsiiObjectRef objRef)
```
    Constructor that initializes the object based on values retrieved from the JsiiObject.
    
    Parameters:
    
    objRef - Reference to the JSII managed object.
  - Jsii$Proxy
```
protected Jsii$Proxy(NodePackageOptions.Builder builder)
```
    Constructor that initializes the object based on literal property values passed by the NodePackageOptions.Builder.
- Method Detail
  - getAllowLibraryDependencies
```
public final Boolean getAllowLibraryDependencies()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Allow the project to include `peerDependencies` and `bundledDependencies`.
    This is normally only allowed for libraries. For apps, there's no meaning for specifying these.
    Default: true
    
    Specified by:
    
    getAllowLibraryDependencies in interface NodePackageOptions
  - getAuthorEmail
```
public final String getAuthorEmail()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's e-mail.
    
    Specified by:
    
    getAuthorEmail in interface NodePackageOptions
  - getAuthorName
```
public final String getAuthorName()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's name.
    
    Specified by:
    
    getAuthorName in interface NodePackageOptions
  - getAuthorOrganization
```
public final Boolean getAuthorOrganization()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's Organization.
    
    Specified by:
    
    getAuthorOrganization in interface NodePackageOptions
  - getAuthorUrl
```
public final String getAuthorUrl()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Author's URL / Website.
    
    Specified by:
    
    getAuthorUrl in interface NodePackageOptions
  - getAutoDetectBin
```
public final Boolean getAutoDetectBin()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Automatically add all executables under the `bin` directory to your `package.json` file under the `bin` section.
    Default: true
    
    Specified by:
    
    getAutoDetectBin in interface NodePackageOptions
  - getBin
```
public final Map<String,String> getBin()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Binary programs vended with your module.
    You can use this option to add/customize how binaries are represented in your package.json, but unless autoDetectBin is false, every executable file under bin will automatically be added to this section.
    
    Specified by:
    
    getBin in interface NodePackageOptions
  - getBundledDeps
```
public final List<String> getBundledDeps()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) List of dependencies to bundle into this module.
    These modules will be added both to the dependencies section and bundledDependencies section of your package.json.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    
    Specified by:
    
    getBundledDeps in interface NodePackageOptions
  - getCodeArtifactOptions
```
public final CodeArtifactOptions getCodeArtifactOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for publishing npm package to AWS CodeArtifact.
    Default: - undefined
    
    Specified by:
    
    getCodeArtifactOptions in interface NodePackageOptions
  - getDeps
```
public final List<String> getDeps()
```
    Description copied from interface: NodePackageOptions
    (experimental) Runtime dependencies of this module.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    Default: []
    Example:
    // Example automatically generated from non-compiling source. May contain errors. [ 'express', 'lodash', 'foo@^2' ]
    Specified by:
    
    getDeps in interface NodePackageOptions
  - getDescription
```
public final String getDescription()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The description is just a string that helps people understand the purpose of the package.
    It can be used when searching for packages in a package manager as well. See https://classic.yarnpkg.com/en/docs/package-json/#toc-description
    
    Specified by:
    
    getDescription in interface NodePackageOptions
  - getDevDeps
```
public final List<String> getDevDeps()
```
    Description copied from interface: NodePackageOptions
    (experimental) Build dependencies for this module.
    These dependencies will only be available in your build environment but will not be fetched when this module is consumed.
    The recommendation is to only specify the module name here (e.g. express). This will behave similar to yarn add or npm install in the sense that it will add the module as a dependency to your package.json file with the latest version (^). You can specify semver requirements in the same syntax passed to npm i or yarn add (e.g. express@^2) and this will be what you package.json will eventually include.
    Default: []
    Example:
    // Example automatically generated from non-compiling source. May contain errors. [ 'typescript', '@types/express' ]
    Specified by:
    
    getDevDeps in interface NodePackageOptions
  - getEntrypoint
```
public final String getEntrypoint()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Module entrypoint (`main` in `package.json`).
    Set to an empty string to not include main in your package.json
    Default: "lib/index.js"
    
    Specified by:
    
    getEntrypoint in interface NodePackageOptions
  - getHomepage
```
public final String getHomepage()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Package's Homepage / Website.
    
    Specified by:
    
    getHomepage in interface NodePackageOptions
  - getKeywords
```
public final List<String> getKeywords()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Keywords to include in `package.json`.
    
    Specified by:
    
    getKeywords in interface NodePackageOptions
  - getLicense
```
public final String getLicense()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) License's SPDX identifier.
    See https://github.com/projen/projen/tree/main/license-text for a list of supported licenses. Use the licensed option if you want to no license to be specified.
    Default: "Apache-2.0"
    
    Specified by:
    
    getLicense in interface NodePackageOptions
  - getLicensed
```
public final Boolean getLicensed()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Indicates if a license should be added.
    Default: true
    
    Specified by:
    
    getLicensed in interface NodePackageOptions
  - getMaxNodeVersion
```
public final String getMaxNodeVersion()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Minimum node.js version to require via `engines` (inclusive).
    Default: - no max
    
    Specified by:
    
    getMaxNodeVersion in interface NodePackageOptions
  - getMinNodeVersion
```
public final String getMinNodeVersion()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Minimum Node.js version to require via package.json `engines` (inclusive).
    Default: - no "engines" specified
    
    Specified by:
    
    getMinNodeVersion in interface NodePackageOptions
  - getNpmAccess
```
public final NpmAccess getNpmAccess()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) 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`.
    
    Specified by:
    
    getNpmAccess in interface NodePackageOptions
  - getNpmRegistry
```
public final String getNpmRegistry()
```
    Description copied from interface: NodePackageOptions
    
    (deprecated) The host name of the npm registry to publish to.
    Cannot be set together with npmRegistryUrl.
    
    Specified by:
    
    getNpmRegistry in interface NodePackageOptions
  - getNpmRegistryUrl
```
public final String getNpmRegistryUrl()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The base URL of the npm package registry.
    Must be a URL (e.g. start with "https://" or "http://")
    Default: "https://registry.npmjs.org"
    
    Specified by:
    
    getNpmRegistryUrl in interface NodePackageOptions
  - getNpmTokenSecret
```
public final String getNpmTokenSecret()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) GitHub secret which contains the NPM token to use when publishing packages.
    Default: "NPM_TOKEN"
    
    Specified by:
    
    getNpmTokenSecret in interface NodePackageOptions
  - getPackageManager
```
public final NodePackageManager getPackageManager()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The Node Package Manager used to execute scripts.
    Default: NodePackageManager.YARN
    
    Specified by:
    
    getPackageManager in interface NodePackageOptions
  - getPackageName
```
public final String getPackageName()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The "name" in package.json.
    Default: - defaults to project name
    
    Specified by:
    
    getPackageName in interface NodePackageOptions
  - getPeerDependencyOptions
```
public final PeerDependencyOptions getPeerDependencyOptions()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Options for `peerDeps`.
    
    Specified by:
    
    getPeerDependencyOptions in interface NodePackageOptions
  - getPeerDeps
```
public final List<String> getPeerDeps()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Peer dependencies for this module.
    Dependencies listed here are required to be installed (and satisfied) by the consumer of this library. Using peer dependencies allows you to ensure that only a single module of a certain library exists in the node_modules tree of your consumers.
    Note that prior to npm@7, peer dependencies are not automatically installed, which means that adding peer dependencies to a library will be a breaking change for your customers.
    Unless peerDependencyOptions.pinnedDevDependency is disabled (it is enabled by default), projen will automatically add a dev dependency with a pinned version for each peer dependency. This will ensure that you build & test your module against the lowest peer version required.
    Default: []
    
    Specified by:
    
    getPeerDeps in interface NodePackageOptions
  - getRepository
```
public final String getRepository()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) The repository is the location where the actual code for your package lives.
    See https://classic.yarnpkg.com/en/docs/package-json/#toc-repository
    
    Specified by:
    
    getRepository in interface NodePackageOptions
  - getRepositoryDirectory
```
public final String getRepositoryDirectory()
```
    Description copied from interface: NodePackageOptions
    
    (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.
    
    Specified by:
    
    getRepositoryDirectory in interface NodePackageOptions
  - getScripts
```
public final Map<String,String> getScripts()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) npm scripts to include.
    If a script has the same name as a standard script, the standard script will be overwritten.
    Default: {}
    
    Specified by:
    
    getScripts in interface NodePackageOptions
  - getStability
```
public final String getStability()
```
    Description copied from interface: NodePackageOptions
    
    (experimental) Package's Stability.
    
    Specified by:
    
    getStability in interface NodePackageOptions
  - $jsii$toJson
```
@Internal
public com.fasterxml.jackson.databind.JsonNode $jsii$toJson()
```
    Specified by:
    
    $jsii$toJson in interface software.amazon.jsii.JsiiSerializable
  - equals
```
public final boolean equals(Object o)
```
    Overrides:
    
    equals in class Object
  - hashCode
```
public final int hashCode()
```
    Overrides:
    
    hashCode in class Object

Class NodePackageOptions.Jsii$Proxy

Nested Class Summary

Nested classes/interfaces inherited from class software.amazon.jsii.JsiiObject

Nested classes/interfaces inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

Constructor Summary

Method Summary

Methods inherited from class software.amazon.jsii.JsiiObject

Methods inherited from class java.lang.Object

Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions

Constructor Detail

Jsii$Proxy

Jsii$Proxy

Method Detail

getAllowLibraryDependencies

getAuthorEmail

getAuthorName

getAuthorOrganization

getAuthorUrl

getAutoDetectBin

getBin

getBundledDeps

getCodeArtifactOptions

getDeps

getDescription

getDevDeps

getEntrypoint

getHomepage

getKeywords

getLicense

getLicensed

getMaxNodeVersion

getMinNodeVersion

getNpmAccess

getNpmRegistry

getNpmRegistryUrl

getNpmTokenSecret

getPackageManager

getPackageName

getPeerDependencyOptions

getPeerDeps

getRepository

getRepositoryDirectory

getScripts

getStability

$jsii$toJson

equals

hashCode