The folding range provider interface defines the contract between extensions and Folding in the editor.

Fields

provideFoldingRanges(document:TextDocument, context:FoldingContext, token:CancellationToken):ProviderResult<Array<FoldingRange>>

Returns a list of folding ranges or null and undefined if the provider does not want to participate or was cancelled.

Parameters:

document

The document in which the command was invoked.

context

Additional context information (for future use)

token

A cancellation token.

@:optionaloptionalonDidChangeFoldingRanges:Null<Event<Void>>

An optional event to signal that the folding ranges from this provider have changed.