Theia API Documentation v1.65.0
    Preparing search index...

    Class BackendPreferenceStorage

    Abtracts the way to read and write preferences to a given resource

    Implements

    Index

    Constructors

    constructor

    Properties

    currentContent encoding encodingService fileSystem jsonEditor onDidChangeFileContent onDidChangeFileContentListeners pendingWrites uri writeDeferred writeFile

    Methods

    dispose doWrite read waitForWrite writeValue

    Constructors

    Properties

    currentContent: undefined | string = undefined
    encoding: string = UTF8
    encodingService: EncodingService
    fileSystem: DiskFileSystemProvider
    jsonEditor: JSONCEditor
    onDidChangeFileContent: Registration<FileContentStatus, Promise<boolean>> = ...

    List of listeners that will get a string with the newly stored resource content and should return a promise that resolves when they are done with their processing

    onDidChangeFileContentListeners: ListenerList<
        FileContentStatus,
        Promise<boolean>,
    > = ...
    pendingWrites: WriteOperation[] = []
    uri: URI
    writeDeferred: Deferred<boolean> = ...
    writeFile: DebouncedFunc<() => void> = ...

    Methods

    • Write a value to the underlying preference store

      Parameters

      • key: string

        the preference key

      • path: string[]

        the path to the JSON object to change

      • value: JSONValue

        the new preference value

      Returns Promise<boolean>

      a promise that will resolve when all "onStored" listeners have finished

    Settings

    Member Visibility

    On This Page

    Constructors
    Properties
    Methods