io.github.cdklabs.projen.cdk

Interface ConstructLibraryOptions

All Superinterfaces:

GitHubProjectOptions, JsiiProjectOptions, software.amazon.jsii.JsiiSerializable, NodePackageOptions, NodeProjectOptions, ProjectOptions, ReleaseProjectOptions, TypeScriptProjectOptions

All Known Subinterfaces:

AwsCdkConstructLibraryOptions, ConstructLibraryAwsOptions, ConstructLibraryCdk8sOptions, ConstructLibraryCdktfOptions

All Known Implementing Classes:

AwsCdkConstructLibraryOptions.Jsii$Proxy, ConstructLibraryAwsOptions.Jsii$Proxy, ConstructLibraryCdk8sOptions.Jsii$Proxy, ConstructLibraryCdktfOptions.Jsii$Proxy, ConstructLibraryOptions.Jsii$Proxy

@Generated(value="jsii-pacmak/1.47.0 (build 86d2c33)",
           date="2021-12-20T00:39:28.615Z")
 @Stability(value=Experimental)
public interface ConstructLibraryOptions
extends software.amazon.jsii.JsiiSerializable, JsiiProjectOptions

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	ConstructLibraryOptions.Builder A builder for ConstructLibraryOptions
static class	ConstructLibraryOptions.Jsii$Proxy An implementation for ConstructLibraryOptions

Method Summary

Modifier and Type	Method and Description
static ConstructLibraryOptions.Builder	builder()
default Catalog	getCatalog() (experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.

Methods inherited from interface io.github.cdklabs.projen.cdk.JsiiProjectOptions

getAuthor, getAuthorAddress, getCompat, getCompatIgnore, getDotnet, getExcludeTypescript, getPublishToGo, getPublishToMaven, getPublishToNuget, getPublishToPypi, getPython, getRepositoryUrl, getRootdir

Methods inherited from interface io.github.cdklabs.projen.typescript.TypeScriptProjectOptions

getDisableTsconfig, getDocgen, getDocsDirectory, getEntrypointTypes, getEslint, getEslintOptions, getLibdir, getPackageValue, getProjenrcTs, getProjenrcTsOptions, getSampleCode, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigDevFile, getTypescriptVersion

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

getAutoApproveProjenUpgrades, getAutoApproveUpgrades, getBuildWorkflow, getBundlerOptions, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenUpgradeAutoMerge, getProjenUpgradeSchedule, getProjenUpgradeSecret, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion

Methods inherited from interface io.github.cdklabs.projen.github.GitHubProjectOptions

getAutoApproveOptions, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getReadme, getStale, getStaleOptions, getVscode

Methods inherited from interface io.github.cdklabs.projen.ProjectOptions

getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions

Methods inherited from interface software.amazon.jsii.JsiiSerializable

$jsii$toJson

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

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

Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions

getAntitamper, getArtifactsDirectory, getJsiiReleaseVersion, getMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishTasks, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn

Method Detail

getCatalog

@Stability(value=Experimental)
 @Nullable
default Catalog getCatalog()

(experimental) Libraries will be picked up by the construct catalog when they are published to npm as jsii modules and will be published under:.

https://awscdk.io/packages/[@SCOPE/]PACKAGE@VERSION

The catalog will also post a tweet to https://twitter.com/awscdkio with the package name, description and the above link. You can disable these tweets through { announce: false }.

You can also add a Twitter handle through { twitter: 'xx' } which will be mentioned in the tweet.

Default: - new version will be announced

See Also:

https://github.com/construct-catalog/catalog

builder

@Stability(value=Experimental)
static ConstructLibraryOptions.Builder builder()

Specified by:

builder in interface GitHubProjectOptions

Specified by:

builder in interface JsiiProjectOptions

Specified by:

builder in interface NodePackageOptions

Specified by:

builder in interface NodeProjectOptions

Specified by:

builder in interface ProjectOptions

Specified by:

builder in interface ReleaseProjectOptions

Specified by:

builder in interface TypeScriptProjectOptions

Returns:

a ConstructLibraryOptions.Builder of ConstructLibraryOptions