Class ConfigurableMutableResource

constructor

• new ConfigurableMutableResource(
      uri: URI,
      options?: ResourceInitializationOptions,
  ): ConfigurableMutableResource

  Parameters

  • uri: URI
  • Optionaloptions: ResourceInitializationOptions

  Returns ConfigurableMutableResource

ReadonlyonDidChangeContents

ReadonlyonDidChangeReadOnly

Readonlyuri

autosaveable

• get autosaveable(): boolean

  If false, the application should not attempt to auto-save this resource.

  Returns boolean

contents

• get contents(): string | Promise<string>

  Returns string | Promise<string>

initiallyDirty

• get initiallyDirty(): boolean

  Returns boolean

readOnly

• get readOnly(): undefined | boolean | MarkdownString

  Returns undefined | boolean | MarkdownString

dispose

• dispose(): void

  Dispose this object.

  Returns void

readContents

• readContents(): Promise<string>

  Reads latest content of this resource.

  If a resource supports versioning it updates version to latest. If a resource supports encoding it updates encoding to latest.

  Returns Promise<string>

  Throws

  ResourceError.NotFound if a resource not found

saveContents

• saveContents(contents: string): Promise<void>

  Rewrites the complete content for this resource. If a resource does not exist it will be created.

  If a resource supports versioning clients can pass some version to check against it, if it is not provided latest version is used.

  It updates version and encoding to latest.

  Parameters

  • contents: string

  Returns Promise<void>

  Throws

  ResourceError.OutOfSync if latest resource version is out of sync with the given

update

• update(options: ResourceInitializationOptions): void

  Parameters

  • options: ResourceInitializationOptions

  Returns void