Package 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.96.0 (build 921e240)", date="2024-03-28T21:16:42.952Z") @Stability(Experimental) public interface ConstructLibraryOptions extends software.amazon.jsii.JsiiSerializable, JsiiProjectOptions
-
-
Nested Class Summary
Nested Classes Modifier and Type Interface Description static classConstructLibraryOptions.BuilderA builder forConstructLibraryOptionsstatic classConstructLibraryOptions.Jsii$ProxyAn implementation forConstructLibraryOptions
-
Method Summary
All Methods Static Methods Instance Methods Default Methods Modifier and Type Method Description static ConstructLibraryOptions.Builderbuilder()default CataloggetCatalog()(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.github.GitHubProjectOptions
getAutoApproveOptions, getAutoMerge, getAutoMergeOptions, getClobber, getDevContainer, getGithub, getGithubOptions, getGitpod, getMergify, getMergifyOptions, getProjectType, getProjenCredentials, getProjenTokenSecret, getReadme, getStale, getStaleOptions, getVscode
-
Methods inherited from interface io.github.cdklabs.projen.cdk.JsiiProjectOptions
getAuthor, getAuthorAddress, getCompat, getCompatIgnore, getCompressAssembly, getDocgenFilePath, getDotnet, getExcludeTypescript, getJsiiVersion, getPublishToGo, getPublishToMaven, getPublishToNuget, getPublishToPypi, getPython, getRepositoryUrl, getRootdir
-
Methods inherited from interface io.github.cdklabs.projen.javascript.NodePackageOptions
getAllowLibraryDependencies, getAuthorEmail, getAuthorName, getAuthorOrganization, getAuthorUrl, getAutoDetectBin, getBin, getBugsEmail, getBugsUrl, getBundledDeps, getCodeArtifactOptions, getDeps, getDescription, getDevDeps, getEntrypoint, getHomepage, getKeywords, getLicense, getLicensed, getMaxNodeVersion, getMinNodeVersion, getNpmAccess, getNpmProvenance, getNpmRegistry, getNpmRegistryUrl, getNpmTokenSecret, getPackageManager, getPackageName, getPeerDependencyOptions, getPeerDeps, getPnpmVersion, getRepository, getRepositoryDirectory, getScopedPackagesOptions, getScripts, getStability, getYarnBerryOptions
-
Methods inherited from interface io.github.cdklabs.projen.javascript.NodeProjectOptions
getArtifactsDirectory, getAutoApproveUpgrades, getBuildWorkflow, getBuildWorkflowTriggers, getBundlerOptions, getCheckLicenses, getCodeCov, getCodeCovTokenSecret, getCopyrightOwner, getCopyrightPeriod, getDefaultReleaseBranch, getDependabot, getDependabotOptions, getDepsUpgrade, getDepsUpgradeOptions, getGitignore, getJest, getJestOptions, getMutableBuild, getNpmignore, getNpmignoreEnabled, getNpmIgnoreOptions, getPackageValue, getPrettier, getPrettierOptions, getProjenDevDependency, getProjenrcJs, getProjenrcJsOptions, getProjenVersion, getPullRequestTemplate, getPullRequestTemplateContents, getRelease, getReleaseToNpm, getReleaseWorkflow, getWorkflowBootstrapSteps, getWorkflowGitIdentity, getWorkflowNodeVersion, getWorkflowPackageCache
-
Methods inherited from interface io.github.cdklabs.projen.ProjectOptions
getCommitGenerated, getGitIgnoreOptions, getGitOptions, getLogging, getName, getOutdir, getParent, getProjenCommand, getProjenrcJson, getProjenrcJsonOptions, getRenovatebot, getRenovatebotOptions
-
Methods inherited from interface io.github.cdklabs.projen.release.ReleaseProjectOptions
getJsiiReleaseVersion, getMajorVersion, getMinMajorVersion, getNpmDistTag, getPostBuildSteps, getPrerelease, getPublishDryRun, getPublishTasks, getReleasableCommits, getReleaseBranches, getReleaseEveryCommit, getReleaseFailureIssue, getReleaseFailureIssueLabel, getReleaseSchedule, getReleaseTagPrefix, getReleaseTrigger, getReleaseWorkflowName, getReleaseWorkflowSetupSteps, getVersionrcOptions, getWorkflowContainerImage, getWorkflowRunsOn, getWorkflowRunsOnGroup
-
Methods inherited from interface io.github.cdklabs.projen.typescript.TypeScriptProjectOptions
getDisableTsconfig, getDisableTsconfigDev, getDocgen, getDocsDirectory, getEntrypointTypes, getEslint, getEslintOptions, getLibdir, getProjenrcTs, getProjenrcTsOptions, getSampleCode, getSrcdir, getTestdir, getTsconfig, getTsconfigDev, getTsconfigDevFile, getTsJestOptions, getTypescriptVersion
-
-
-
-
Method Detail
-
getCatalog
@Stability(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
-
builder
@Stability(Experimental) static ConstructLibraryOptions.Builder builder()
- Returns:
- a
ConstructLibraryOptions.BuilderofConstructLibraryOptions
-
-