Skip to main content
Version: v1

IGCRuntimeOptions Interface

Signature​

export interface IGCRuntimeOptions

Properties​

Property Modifiers Type Description
disableGC optional boolean Flag that will disable garbage collection if set to true. Can be used to disable running GC on container where is allowed via the gcAllowed option.
gcAllowed optional boolean Flag that if true, will enable running garbage collection (GC) in a container. GC has mark phase and sweep phase. In mark phase, unreferenced objects are identified and marked as such in the summary. This option enables the mark phase. In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions. Sweep phase can be enabled via the "sweepAllowed" option. Note: This setting becomes part of the container's summary and cannot be changed.
runFullGC optional boolean Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node changed or not.
sweepAllowed optional boolean Flag that if true, enables GC's sweep phase which will eventually delete unreferenced objects from the container. This flag should only be set to true if "gcAllowed" is true. Note: This setting becomes part of the container's summary and cannot be changed.

Index Signatures​

IndexSignature Description
[key: string]: any Allows additional GC options to be passed.

Property Details​

disableGC​

Flag that will disable garbage collection if set to true. Can be used to disable running GC on container where is allowed via the gcAllowed option.

Signature​

disableGC?: boolean;

Type: boolean

gcAllowed​

Flag that if true, will enable running garbage collection (GC) in a container. GC has mark phase and sweep phase. In mark phase, unreferenced objects are identified and marked as such in the summary. This option enables the mark phase. In sweep phase, unreferenced objects are eventually deleted from the container if they meet certain conditions. Sweep phase can be enabled via the "sweepAllowed" option. Note: This setting becomes part of the container's summary and cannot be changed.

Signature​

gcAllowed?: boolean;

Type: boolean

runFullGC​

Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node changed or not.

Signature​

runFullGC?: boolean;

Type: boolean

sweepAllowed​

Flag that if true, enables GC's sweep phase which will eventually delete unreferenced objects from the container. This flag should only be set to true if "gcAllowed" is true. Note: This setting becomes part of the container's summary and cannot be changed.

Signature​

sweepAllowed?: boolean;

Type: boolean

Index Signature Details​

[key: string]: any​

Allows additional GC options to be passed.

Signature​

[key: string]: any;