Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Remove duplicative definition of getGCData #23519

Merged
merged 1 commit into from
Jan 14, 2025
Merged

Remove duplicative definition of getGCData #23519

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1 change: 0 additions & 1 deletion packages/dds/shared-object-base/api-report/shared-object-base.legacy.alpha.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,6 @@ export interface IFluidSerializer {
// @alpha
export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent> {
bindToContext(): void;
getGCData(fullGC?: boolean): IGarbageCollectionData;
}

// @alpha
Expand Down
4 changes: 2 additions & 2 deletions packages/dds/shared-object-base/src/sharedObject.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -353,7 +353,7 @@ export abstract class SharedObjectCore<
): Promise<ISummaryTreeWithStats>;

/**
* {@inheritDoc (ISharedObject:interface).getGCData}
* {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}
*/
public abstract getGCData(fullGC?: boolean): IGarbageCollectionData;

Expand Down Expand Up @@ -766,7 +766,7 @@ export abstract class SharedObject<
}

/**
* {@inheritDoc (ISharedObject:interface).getGCData}
* {@inheritDoc @fluidframework/datastore-definitions#(IChannel:interface).getGCData}
*/
public getGCData(fullGC: boolean = false): IGarbageCollectionData {
// Set _isGCing to true. This flag is used to ensure that we only use SummarySerializer to serialize handles
Expand Down
8 changes: 0 additions & 8 deletions packages/dds/shared-object-base/src/types.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,6 @@ import {
} from "@fluidframework/core-interfaces";
import { IChannel } from "@fluidframework/datastore-definitions/internal";
import { ISequencedDocumentMessage } from "@fluidframework/driver-definitions/internal";
import { IGarbageCollectionData } from "@fluidframework/runtime-definitions/internal";

/**
* Events emitted by {@link ISharedObject}.
Expand Down Expand Up @@ -66,11 +65,4 @@ export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjec
* the runtime attaches.
*/
bindToContext(): void;

/**
* Returns the GC data for this shared object. It contains a list of GC nodes that contains references to
* other GC nodes.
* @param fullGC - true to bypass optimizations and force full generation of GC data.
*/
getGCData(fullGC?: boolean): IGarbageCollectionData;
}
1 change: 0 additions & 1 deletion packages/framework/fluid-framework/api-report/fluid-framework.legacy.alpha.api.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -743,7 +743,6 @@ export interface ISharedMapEvents extends ISharedObjectEvents {
// @alpha
export interface ISharedObject<TEvent extends ISharedObjectEvents = ISharedObjectEvents> extends IChannel, IEventProvider<TEvent> {
bindToContext(): void;
getGCData(fullGC?: boolean): IGarbageCollectionData;
}

// @alpha
Expand Down
Loading