@nogoo9/mcp-server-cloud-fs / StorageProvider

Interface: StorageProvider

Defined in: providers/interface.ts:60

Abstract storage backend for cloud object stores.

Every provider implements CRUD operations scoped to a ParsedRoot. Built-in implementations: S3Provider, AzureProvider, GcsProvider, MemoryProvider, SqliteProvider.

Methods

copyObject()

copyObject(root, srcKey, dstKey): Promise<void>

Defined in: providers/interface.ts:68

Parameters

root

ParsedRoot

srcKey

string

dstKey

string

Returns

Promise<void>

---

createPrefix()

createPrefix(root, prefix): Promise<void>

Defined in: providers/interface.ts:75

Parameters

root

ParsedRoot

prefix

string

Returns

Promise<void>

---

deleteObject()

deleteObject(root, key): Promise<void>

Defined in: providers/interface.ts:67

Parameters

root

ParsedRoot

key

string

Returns

Promise<void>

---

getObject()

getObject(root, key, range?): Promise<Buffer<ArrayBufferLike>>

Defined in: providers/interface.ts:61

Parameters

root

ParsedRoot

key

string

range?

endByte?

number

startByte

number

Returns

Promise<Buffer<ArrayBufferLike>>

---

getObjectMetadata()?

optional getObjectMetadata(root, key): Promise<ObjectMetadata>

Defined in: providers/interface.ts:93

Get extended metadata and tags for an object.

Parameters

root

ParsedRoot

key

string

Returns

Promise<ObjectMetadata>

---

getObjectTags()?

optional getObjectTags(root, key): Promise<Record<string, string>>

Defined in: providers/interface.ts:103

Get tags for an object.

Parameters

root

ParsedRoot

key

string

Returns

Promise<Record<string, string>>

---

getPresignedUrl()?

optional getPresignedUrl(root, key, opts): Promise<string>

Defined in: providers/interface.ts:81

Generate a presigned URL for temporary access to an object. Not all providers support this — check before calling.

Parameters

root

ParsedRoot

key

string

opts

expiresIn

number

URL validity in seconds.

operation

"get" | "put"

'get' for download, 'put' for upload.

Returns

Promise<string>

---

headObject()

headObject(root, key): Promise<ObjectInfo>

Defined in: providers/interface.ts:69

Parameters

root

ParsedRoot

key

string

Returns

Promise<ObjectInfo>

---

listObjects()

listObjects(root, prefix, delimiter?): Promise<ListResult>

Defined in: providers/interface.ts:70

Parameters

root

ParsedRoot

prefix

string

delimiter?

string

Returns

Promise<ListResult>

---

listObjectVersions()?

optional listObjectVersions(root, key): Promise<ObjectVersion[]>

Defined in: providers/interface.ts:109

List version history for an object.

Parameters

root

ParsedRoot

key

string

Returns

Promise<ObjectVersion[]>

---

putObject()

putObject(root, key, content): Promise<void>

Defined in: providers/interface.ts:66

Parameters

root

ParsedRoot

key

string

content

Buffer

Returns

Promise<void>

---

restoreObjectVersion()?

optional restoreObjectVersion(root, key, versionId): Promise<void>

Defined in: providers/interface.ts:112

Restore a previous version of an object (copies it over current).

Parameters

root

ParsedRoot

key

string

versionId

string

Returns

Promise<void>

---

setObjectTags()?

optional setObjectTags(root, key, tags): Promise<void>

Defined in: providers/interface.ts:96

Set tags on an object. Replaces all existing tags.

Parameters

root

ParsedRoot

key

string

tags

Record<string, string>

Returns

Promise<void>