VS Code API
    Preparing search index...

    Interface TextDocumentContentProvider

    A text document content provider allows to add readonly documents to the editor, such as source from a dll or generated html from md.

    Content providers are registered for a uri-scheme. When a uri with that scheme is to be loaded the content provider is asked.

    interface TextDocumentContentProvider {
        onDidChange?: Event<Uri>;
        provideTextDocumentContent(
            uri: Uri,
            token: CancellationToken,
        ): ProviderResult<string>;
    }
    Index

    Properties

    onDidChange?: Event<Uri>

    An event to signal a resource has changed.

    Methods

    • Provide textual content for a given uri.

      The editor will use the returned string-content to create a readonly document. Resources allocated should be released when the corresponding document has been closed.

      Note: The contents of the created document might not be identical to the provided text due to end-of-line-sequence normalization.

      Parameters

      Returns ProviderResult<string>

      A string or a thenable that resolves to such.