Class ConfigurableMutableReferenceResource

Implements

Resource

Index

Constructors

Properties

Accessors

autosaveable contents initiallyDirty onDidChangeContents readOnly uri

Methods

dispose readContents saveContents update

Constructors

constructor

new ConfigurableMutableReferenceResource(
reference: Reference<ConfigurableMutableResource>,
): ConfigurableMutableReferenceResource
Parameters
- reference: Reference<ConfigurableMutableResource>
Returns ConfigurableMutableReferenceResource
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:123

Properties

`Protected`reference

reference: Reference<ConfigurableMutableResource>

Accessors

autosaveable

get autosaveable(): boolean
If false, the application should not attempt to auto-save this resource.

Returns boolean
Implementation of Resource.autosaveable
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:157

contents

get contents(): string | Promise<string>
Returns string | Promise<string>
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:161

initiallyDirty

get initiallyDirty(): boolean
Returns boolean
Implementation of Resource.initiallyDirty
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:153

onDidChangeContents

get onDidChangeContents(): Event<void>
Returns Event<void>
Implementation of Resource.onDidChangeContents
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:129

readOnly

get readOnly(): undefined | boolean | MarkdownString
Returns undefined | boolean | MarkdownString
Implementation of Resource.readOnly
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:149

uri

get uri(): URI
Returns URI
Implementation of Resource.uri
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:125

Methods

dispose

dispose(): void
Dispose this object.

Returns void
Implementation of Resource.dispose
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:133

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
Implementation of Resource.readContents
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:137

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
Implementation of Resource.saveContents
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:141

update

update(options: ResourceInitializationOptions): void
Parameters
- options: ResourceInitializationOptions
Returns void
- Defined in ai-core/src/common/configurable-in-memory-resources.ts:145