Package io.github.cdklabs.projen.javascript

Interface YarnrcOptions

  • All Superinterfaces:
    software.amazon.jsii.JsiiSerializable
    All Known Implementing Classes:
    YarnrcOptions.Jsii$Proxy
    @Generated(value="jsii-pacmak/1.96.0 (build 921e240)",
           date="2024-03-28T21:16:43.221Z")
@Stability(Experimental)
public interface YarnrcOptions
extends software.amazon.jsii.JsiiSerializable
    (experimental) Configuration for .yarnrc.yml in Yarn Berry v4.

    • Method Detail

      • getCacheFolder

        @Stability(Experimental)
@Nullable
default String getCacheFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#cacheFolder.

      • getCacheMigrationMode

        @Stability(Experimental)
@Nullable
default YarnCacheMigrationMode getCacheMigrationMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#cacheMigrationMode.

      • getChangesetBaseRefs

        @Stability(Experimental)
@Nullable
default List<String> getChangesetBaseRefs()
        (experimental) https://yarnpkg.com/configuration/yarnrc#changesetBaseRefs.

      • getChangesetIgnorePatterns

        @Stability(Experimental)
@Nullable
default List<String> getChangesetIgnorePatterns()
        (experimental) https://yarnpkg.com/configuration/yarnrc#changesetIgnorePatterns.

      • getChecksumBehavior

        @Stability(Experimental)
@Nullable
default YarnChecksumBehavior getChecksumBehavior()
        (experimental) https://yarnpkg.com/configuration/yarnrc#checksumBehavior.

      • getCloneConcurrency

        @Stability(Experimental)
@Nullable
default Number getCloneConcurrency()
        (experimental) https://yarnpkg.com/configuration/yarnrc#cloneConcurrency.

      • getCompressionLevel

        @Stability(Experimental)
@Nullable
default Object getCompressionLevel()
        (experimental) https://yarnpkg.com/configuration/yarnrc#compressionLevel.

      • getConstraintsPath

        @Stability(Experimental)
@Nullable
default String getConstraintsPath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#constraintsPath.

      • getDefaultLanguageName

        @Stability(Experimental)
@Nullable
default String getDefaultLanguageName()
        (experimental) https://yarnpkg.com/configuration/yarnrc#defaultLanguageName.

      • getDefaultProtocol

        @Stability(Experimental)
@Nullable
default String getDefaultProtocol()
        (experimental) https://yarnpkg.com/configuration/yarnrc#defaultProtocol.

      • getDefaultSemverRangePrefix

        @Stability(Experimental)
@Nullable
default YarnDefaultSemverRangePrefix getDefaultSemverRangePrefix()
        (experimental) https://yarnpkg.com/configuration/yarnrc#defaultSemverRangePrefix.

      • getDeferredVersionFolder

        @Stability(Experimental)
@Nullable
default String getDeferredVersionFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#deferredVersionFolder.

      • getEnableColors

        @Stability(Experimental)
@Nullable
default Boolean getEnableColors()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableColors.

      • getEnableConstraintsCheck

        @Stability(Experimental)
@Nullable
default Boolean getEnableConstraintsCheck()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableConstraintsCheck.

      • getEnableGlobalCache

        @Stability(Experimental)
@Nullable
default Boolean getEnableGlobalCache()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableGlobalCache.

      • getEnableHardenedMode

        @Stability(Experimental)
@Nullable
default Boolean getEnableHardenedMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableHardenedMode.

      • getEnableHyperlinks

        @Stability(Experimental)
@Nullable
default Boolean getEnableHyperlinks()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableHyperlinks.

      • getEnableImmutableCache

        @Stability(Experimental)
@Nullable
default Boolean getEnableImmutableCache()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableImmutableCache.

      • getEnableImmutableInstalls

        @Stability(Experimental)
@Nullable
default Boolean getEnableImmutableInstalls()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableImmutableInstalls.

      • getEnableInlineBuilds

        @Stability(Experimental)
@Nullable
default Boolean getEnableInlineBuilds()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableInlineBuilds.

      • getEnableInlineHunks

        @Stability(Experimental)
@Nullable
default Boolean getEnableInlineHunks()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableInlineHunks.

      • getEnableMessageNames

        @Stability(Experimental)
@Nullable
default Boolean getEnableMessageNames()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableMessageNames.

      • getEnableMirror

        @Stability(Experimental)
@Nullable
default Boolean getEnableMirror()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableMirror.

      • getEnableNetwork

        @Stability(Experimental)
@Nullable
default Boolean getEnableNetwork()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableNetwork.

      • getEnableOfflineMode

        @Stability(Experimental)
@Nullable
default Boolean getEnableOfflineMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableOfflineMode.

      • getEnableProgressBars

        @Stability(Experimental)
@Nullable
default Boolean getEnableProgressBars()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableProgressBars.

      • getEnableScripts

        @Stability(Experimental)
@Nullable
default Boolean getEnableScripts()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableScripts.

      • getEnableStrictSsl

        @Stability(Experimental)
@Nullable
default Boolean getEnableStrictSsl()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableStrictSsl.

      • getEnableTelemetry

        @Stability(Experimental)
@Nullable
default Boolean getEnableTelemetry()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableTelemetry.

      • getEnableTimers

        @Stability(Experimental)
@Nullable
default Boolean getEnableTimers()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableTimers.

      • getEnableTransparentWorkspaces

        @Stability(Experimental)
@Nullable
default Boolean getEnableTransparentWorkspaces()
        (experimental) https://yarnpkg.com/configuration/yarnrc#enableTransparentWorkspaces.

      • getGlobalFolder

        @Stability(Experimental)
@Nullable
default String getGlobalFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#globalFolder.

      • getHttpProxy

        @Stability(Experimental)
@Nullable
default String getHttpProxy()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpProxy.

      • getHttpRetry

        @Stability(Experimental)
@Nullable
default Number getHttpRetry()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpRetry.

      • getHttpsCaFilePath

        @Stability(Experimental)
@Nullable
default String getHttpsCaFilePath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpsCaFilePath.

      • getHttpsCertFilePath

        @Stability(Experimental)
@Nullable
default String getHttpsCertFilePath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpsCertFilePath.

      • getHttpsKeyFilePath

        @Stability(Experimental)
@Nullable
default String getHttpsKeyFilePath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpsKeyFilePath.

      • getHttpsProxy

        @Stability(Experimental)
@Nullable
default String getHttpsProxy()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpsProxy.

      • getHttpTimeout

        @Stability(Experimental)
@Nullable
default Number getHttpTimeout()
        (experimental) https://yarnpkg.com/configuration/yarnrc#httpTimeout.

      • getIgnoreCwd

        @Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getIgnoreCwd()
        Deprecated.
        • removed in Yarn v4 and newer
        (deprecated) https://v3.yarnpkg.com/configuration/yarnrc#ignoreCwd.

      • getIgnorePath

        @Stability(Experimental)
@Nullable
default Boolean getIgnorePath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#ignorePath.

      • getImmutablePatterns

        @Stability(Experimental)
@Nullable
default List<String> getImmutablePatterns()
        (experimental) https://yarnpkg.com/configuration/yarnrc#immutablePatterns.

      • getInitFields

        @Stability(Experimental)
@Nullable
default Map<String,​Object> getInitFields()
        (experimental) https://yarnpkg.com/configuration/yarnrc#initFields.

      • getInitScope

        @Stability(Experimental)
@Nullable
default String getInitScope()
        (experimental) https://yarnpkg.com/configuration/yarnrc#initScope.

      • getInjectEnvironmentFiles

        @Stability(Experimental)
@Nullable
default List<String> getInjectEnvironmentFiles()
        (experimental) https://yarnpkg.com/configuration/yarnrc#injectEnvironmentFiles.

      • getInstallStatePath

        @Stability(Experimental)
@Nullable
default String getInstallStatePath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#installStatePath.

      • getLockfileFilename

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getLockfileFilename()
        Deprecated.
        • removed in Yarn v4 and newer
        (deprecated) https://v3.yarnpkg.com/configuration/yarnrc#lockfileFilename.

      • getLogFilters

        @Stability(Experimental)
@Nullable
default List<YarnLogFilter> getLogFilters()
        (experimental) https://yarnpkg.com/configuration/yarnrc#logFilters.

      • getNetworkConcurrency

        @Stability(Experimental)
@Nullable
default Number getNetworkConcurrency()
        (experimental) https://yarnpkg.com/configuration/yarnrc#networkConcurrency.

      • getNetworkSettings

        @Stability(Experimental)
@Nullable
default Map<String,​YarnNetworkSetting> getNetworkSettings()
        (experimental) https://yarnpkg.com/configuration/yarnrc#networkSettings.

      • getNmHoistingLimits

        @Stability(Experimental)
@Nullable
default YarnNmHoistingLimit getNmHoistingLimits()
        (experimental) https://yarnpkg.com/configuration/yarnrc#nmHoistingLimits.

      • getNmMode

        @Stability(Experimental)
@Nullable
default YarnNmMode getNmMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#nmMode.

      • getNmSelfReferences

        @Stability(Experimental)
@Nullable
default Boolean getNmSelfReferences()
        (experimental) https://yarnpkg.com/configuration/yarnrc#nmSelfReferences.

      • getNodeLinker

        @Stability(Experimental)
@Nullable
default YarnNodeLinker getNodeLinker()
        (experimental) https://yarnpkg.com/configuration/yarnrc#nodeLinker.

      • getNpmAlwaysAuth

        @Stability(Experimental)
@Nullable
default Boolean getNpmAlwaysAuth()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAlwaysAuth.

      • getNpmAuditExcludePackages

        @Stability(Experimental)
@Nullable
default List<String> getNpmAuditExcludePackages()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAuditExcludePackages.

      • getNpmAuditIgnoreAdvisories

        @Stability(Experimental)
@Nullable
default List<String> getNpmAuditIgnoreAdvisories()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAuditIgnoreAdvisories.

      • getNpmAuditRegistry

        @Stability(Experimental)
@Nullable
default String getNpmAuditRegistry()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAuditRegistry.

      • getNpmAuthIdent

        @Stability(Experimental)
@Nullable
default String getNpmAuthIdent()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAuthIdent.

      • getNpmAuthToken

        @Stability(Experimental)
@Nullable
default String getNpmAuthToken()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmAuthToken.

      • getNpmPublishAccess

        @Stability(Experimental)
@Nullable
default YarnNpmPublishAccess getNpmPublishAccess()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmPublishAccess.

      • getNpmPublishRegistry

        @Stability(Experimental)
@Nullable
default String getNpmPublishRegistry()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmPublishRegistry.

      • getNpmRegistries

        @Stability(Experimental)
@Nullable
default Map<String,​YarnNpmRegistry> getNpmRegistries()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmRegistries.

      • getNpmRegistryServer

        @Stability(Experimental)
@Nullable
default String getNpmRegistryServer()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmRegistryServer.

      • getNpmScopes

        @Stability(Experimental)
@Nullable
default Map<String,​YarnNpmScope> getNpmScopes()
        (experimental) https://yarnpkg.com/configuration/yarnrc#npmScopes.

      • getPackageExtensions

        @Stability(Experimental)
@Nullable
default Map<String,​YarnPackageExtension> getPackageExtensions()
        (experimental) https://yarnpkg.com/configuration/yarnrc#packageExtensions.

      • getPatchFolder

        @Stability(Experimental)
@Nullable
default String getPatchFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#patchFolder.

      • getPnpDataPath

        @Stability(Deprecated)
@Deprecated
@Nullable
default String getPnpDataPath()
        Deprecated.
        • removed in Yarn v4 and newer
        (deprecated) https://v3.yarnpkg.com/configuration/yarnrc#pnpDataPath.

      • getPnpEnableEsmLoader

        @Stability(Experimental)
@Nullable
default Boolean getPnpEnableEsmLoader()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpEnableEsmLoader.

      • getPnpEnableInlining

        @Stability(Experimental)
@Nullable
default Boolean getPnpEnableInlining()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpEnableInlining.

      • getPnpFallbackMode

        @Stability(Experimental)
@Nullable
default YarnPnpFallbackMode getPnpFallbackMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpFallbackMode.

      • getPnpIgnorePatterns

        @Stability(Experimental)
@Nullable
default List<String> getPnpIgnorePatterns()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpIgnorePatterns.

      • getPnpMode

        @Stability(Experimental)
@Nullable
default YarnPnpMode getPnpMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpMode.

      • getPnpShebang

        @Stability(Experimental)
@Nullable
default String getPnpShebang()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpShebang.

      • getPnpUnpluggedFolder

        @Stability(Experimental)
@Nullable
default String getPnpUnpluggedFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#pnpUnpluggedFolder.

      • getPreferAggregateCacheInfo

        @Stability(Deprecated)
@Deprecated
@Nullable
default Boolean getPreferAggregateCacheInfo()
        Deprecated.
        • removed in Yarn v4 and newer
        (deprecated) https://v3.yarnpkg.com/configuration/yarnrc#preferAggregateCacheInfo.

      • getPreferDeferredVersions

        @Stability(Experimental)
@Nullable
default Boolean getPreferDeferredVersions()
        (experimental) https://yarnpkg.com/configuration/yarnrc#preferDeferredVersions.

      • getPreferInteractive

        @Stability(Experimental)
@Nullable
default Boolean getPreferInteractive()
        (experimental) https://yarnpkg.com/configuration/yarnrc#preferInteractive.

      • getPreferReuse

        @Stability(Experimental)
@Nullable
default Boolean getPreferReuse()
        (experimental) https://yarnpkg.com/configuration/yarnrc#preferReuse.

      • getPreferTruncatedLines

        @Stability(Experimental)
@Nullable
default Boolean getPreferTruncatedLines()
        (experimental) https://yarnpkg.com/configuration/yarnrc#preferTruncatedLines.

      • getProgressBarStyle

        @Stability(Experimental)
@Nullable
default YarnProgressBarStyle getProgressBarStyle()
        (experimental) https://yarnpkg.com/configuration/yarnrc#progressBarStyle.

      • getRcFilename

        @Stability(Experimental)
@Nullable
default String getRcFilename()
        (experimental) https://yarnpkg.com/configuration/yarnrc#rcFilename.

      • getSupportedArchitectures

        @Stability(Experimental)
@Nullable
default YarnSupportedArchitectures getSupportedArchitectures()
        (experimental) https://yarnpkg.com/configuration/yarnrc#supportedArchitectures.

      • getTaskPoolConcurrency

        @Stability(Experimental)
@Nullable
default String getTaskPoolConcurrency()
        (experimental) https://yarnpkg.com/configuration/yarnrc#taskPoolConcurrency.

      • getTelemetryInterval

        @Stability(Experimental)
@Nullable
default Number getTelemetryInterval()
        (experimental) https://yarnpkg.com/configuration/yarnrc#telemetryInterval.

      • getTelemetryUserId

        @Stability(Experimental)
@Nullable
default String getTelemetryUserId()
        (experimental) https://yarnpkg.com/configuration/yarnrc#telemetryUserId.

      • getTsEnableAutoTypes

        @Stability(Experimental)
@Nullable
default Boolean getTsEnableAutoTypes()
        (experimental) https://yarnpkg.com/configuration/yarnrc#tsEnableAutoTypes.

      • getUnsafeHttpWhitelist

        @Stability(Experimental)
@Nullable
default List<String> getUnsafeHttpWhitelist()
        (experimental) https://yarnpkg.com/configuration/yarnrc#unsafeHttpWhitelist.

      • getVirtualFolder

        @Stability(Experimental)
@Nullable
default String getVirtualFolder()
        (experimental) https://yarnpkg.com/configuration/yarnrc#virtualFolder.

      • getWinLinkType

        @Stability(Experimental)
@Nullable
default YarnWinLinkType getWinLinkType()
        (experimental) https://yarnpkg.com/configuration/yarnrc#winLinkType.

      • getWorkerPoolMode

        @Stability(Experimental)
@Nullable
default YarnWorkerPoolMode getWorkerPoolMode()
        (experimental) https://yarnpkg.com/configuration/yarnrc#workerPoolMode.

      • getYarnPath

        @Stability(Experimental)
@Nullable
default String getYarnPath()
        (experimental) https://yarnpkg.com/configuration/yarnrc#yarnPath.