ISummarizerNode Interface

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

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

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

Signature

export interface ISummarizerNode

Properties

Property	Alerts	Modifiers	Type	Description
referenceSequenceNumber	Beta	readonly	number	Latest successfully acked summary reference sequence number

Methods

Method	Alerts	Modifiers	Return Type	Description
createChild(summarizeInternalFn, id, createParam, config)	Beta		ISummarizerNode
getChild(id)	Beta		ISummarizerNode | undefined
invalidate(sequenceNumber)	Beta		void	Marks the node as having a change with the given sequence number.
isSummaryInProgress()	Beta	optional	boolean	True if a summary is currently in progress
recordChange(op)	Beta		void	Records an op representing a change to this node/subtree.
summarize(fullTree, trackState, telemetryContext)	Beta		Promise<ISummarizeResult>	Calls the internal summarize function and handles internal state tracking.
updateBaseSummaryState(snapshot)	Deprecated, Beta		void	Checks if there are any additional path parts for children that need to be loaded from the base summary. Additional path parts represent parts of the path between this SummarizerNode and any child SummarizerNodes that it might have. For example: if datastore "a" contains dds "b", but the path is "/a/.channels/b", then the additional path part is ".channels".

Property Details

referenceSequenceNumber

Latest successfully acked summary reference sequence number

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

readonly referenceSequenceNumber: number;

Type: number

Method Details

createChild

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

createChild(
    summarizeInternalFn: SummarizeInternalFn, 
    id: string, 
    createParam: CreateChildSummarizerNodeParam, 
    config?: ISummarizerNodeConfig): ISummarizerNode;

Parameters

Parameter	Modifiers	Type	Description
summarizeInternalFn		SummarizeInternalFn
id		string
createParam		CreateChildSummarizerNodeParam
config	optional	ISummarizerNodeConfig

Returns

Return type: ISummarizerNode

getChild

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

getChild(id: string): ISummarizerNode | undefined;

Parameters

Parameter	Type	Description
id	string

Returns

Return type: ISummarizerNode | undefined

invalidate

Marks the node as having a change with the given sequence number.

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

invalidate(sequenceNumber: number): void;

Parameters

Parameter	Type	Description
sequenceNumber	number	sequence number of change

isSummaryInProgress

True if a summary is currently in progress

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

isSummaryInProgress?(): boolean;

Returns

Return type: boolean

recordChange

Records an op representing a change to this node/subtree.

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

recordChange(op: ISequencedDocumentMessage): void;

Parameters

Parameter	Type	Description
op	ISequencedDocumentMessage	op of change to record

summarize

Calls the internal summarize function and handles internal state tracking.

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

summarize(fullTree: boolean, trackState?: boolean, telemetryContext?: ITelemetryContext): Promise<ISummarizeResult>;

Parameters

Parameter	Modifiers	Type	Description
fullTree		boolean	true to skip optimizations and always generate the full tree
trackState	optional	boolean	indicates whether the summarizer node should track the state of the summary or not
telemetryContext	optional	ITelemetryContext	summary data passed through the layers for telemetry purposes

Returns

Return type: Promise<ISummarizeResult>

updateBaseSummaryState

Checks if there are any additional path parts for children that need to be loaded from the base summary. Additional path parts represent parts of the path between this SummarizerNode and any child SummarizerNodes that it might have. For example: if datastore "a" contains dds "b", but the path is "/a/.channels/b", then the additional path part is ".channels".

This API is deprecated and will be removed in a future release.

The code now always assumes that all summary nodes have .channels in their handle so there is no need to maintain any additional path information.

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

updateBaseSummaryState(snapshot: ISnapshotTree): void;

Parameters

Parameter	Type	Description
snapshot	ISnapshotTree	the base summary to parse