Class ReferenceMutableResource

Hierarchy

ReferenceMutableResource

Implements

Resource

Index

Constructors

constructor

Properties

reference

Accessors

Methods

Constructors

constructor

new ReferenceMutableResource(reference: Reference<MutableResource>): ReferenceMutableResource

- Defined in packages/core/src/common/resource.ts:233
Parameters
- reference: Reference<MutableResource>
Returns ReferenceMutableResource

Properties

Protected reference

reference: Reference<MutableResource>

Accessors

onDidChangeContents

get onDidChangeContents(): Event<void>

Implementation of Resource.onDidChangeContents
- Defined in packages/core/src/common/resource.ts:239
Returns Event<void>

uri

get uri(): URI

Implementation of Resource.uri
- Defined in packages/core/src/common/resource.ts:235
Returns URI

Methods

dispose

dispose(): void

Implementation of Resource.dispose
- Defined in packages/core/src/common/resource.ts:243
Dispose this object.

Returns void

readContents

readContents(): Promise<string>

Implementation of Resource.readContents
- Defined in packages/core/src/common/resource.ts:247
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>

saveContents

saveContents(contents: string): Promise<void>

Implementation of Resource.saveContents
- Defined in packages/core/src/common/resource.ts:251
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>