Class UntitledResource

Hierarchy

UntitledResource

Implements

Resource

Index

Constructors

constructor

Properties

Accessors

Methods

Constructors

constructor

new UntitledResource(resources: Map<string, UntitledResource>, uri: URI, content?: string): UntitledResource

- Defined in packages/core/src/common/resource.ts:381
Parameters
- resources: Map<string, UntitledResource>
- uri: URI
- Optional content: string
Returns UntitledResource

Properties

Protected Readonly onDidChangeContentsEmitter

onDidChangeContentsEmitter: Emitter<void> = ...

uri

uri: URI

Accessors

encoding

get encoding(): undefined | string

Implementation of Resource.encoding
- Defined in packages/core/src/common/resource.ts:412
Latest read encoding of this resource.

Optional if a resource does not support encoding, check with in operator`. Undefined if a resource did not read content yet.

Returns undefined | string

onDidChangeContents

get onDidChangeContents(): Event<void>

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

version

get version(): undefined | ResourceVersion

Implementation of Resource.version
- Defined in packages/core/src/common/resource.ts:408
Latest read version of this resource.

Optional if a resource does not support versioning, check with in operator`. Undefined if a resource did not read content yet.

Returns undefined | ResourceVersion

Methods

dispose

dispose(): void

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

Returns void

Protected fireDidChangeContents

fireDidChangeContents(): void

- Defined in packages/core/src/common/resource.ts:404
Returns void

readContents

readContents(options?: { encoding?: string }): Promise<string>

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

Parameters
- Optional options: { encoding?: string }
  - Optional encoding?: string
Returns Promise<string>

saveContents

saveContents(content: string, options?: { encoding?: string; overwriteEncoding?: boolean }): Promise<void>

Implementation of Resource.saveContents
- Defined in packages/core/src/common/resource.ts:398
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
- content: string
- Optional options: { encoding?: string; overwriteEncoding?: boolean }
  - Optional encoding?: string
  - Optional overwriteEncoding?: boolean
Returns Promise<void>