IGCRuntimeOptions Interface

This API is provided for existing users, but is not recommended for new users.

To use, import via @fluidframework/container-runtime/legacy.

For more information about our API support guarantees, see here.

Signature

export interface IGCRuntimeOptions

Properties

Property	Alerts	Modifiers	Type	Description
enableGCSweep	Alpha	optional	true	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.
runFullGC	Alpha	optional	boolean	Flag that will bypass optimizations and generate GC data for all nodes irrespective of whether a node changed or not.
sessionExpiryTimeoutMs	Alpha	optional	number	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.
sweepGracePeriodMs	Alpha	optional	number	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.

Index Signatures

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

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

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.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

sweepGracePeriodMs?: number;

Type: number

Index Signature Details

[key: string]: any

Allows additional GC options to be passed.

This API is provided for existing users, but is not recommended for new users.

For more information about our API support guarantees, see here.

Signature

[key: string]: any;