IGCRuntimeOptions Interface

Packages > @fluidframework/container-runtime > IGCRuntimeOptions

Signature

export interface IGCRuntimeOptions

Properties

Index Signatures

Property Details

enableGCSweep

Flag that if true, will enable the full Sweep Phase of garbage collection for this session, where Tombstoned objects are permanently deleted from the container.

IMPORTANT: This only applies if this document is allowed to run Sweep Phase.

Current default behavior is for Sweep Phase not to delete Tombstoned objects, but merely to prevent them from being loaded.

Signature

enableGCSweep?: true;

Type: true

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

sessionExpiryTimeoutMs

Maximum session duration for a new container. If not present, a default value will be used.

Note: This setting is persisted in the container’s summary and cannot be changed.

Signature

sessionExpiryTimeoutMs?: number;

Type: number

sweepGracePeriodMs

Delay between when Tombstone should run and when the object should be deleted. This grace period gives a chance to intervene to recover if needed, before Sweep deletes the object. If not present, a default (non-zero) value will be used.

Signature

sweepGracePeriodMs?: number;

Type: number

Index Signature Details

[key: string]: any

Allows additional GC options to be passed.

Signature

[key: string]: any;