Skip to content

TypeScript API / contentia/storage/s3 / S3DataSource

Class: S3DataSource ​

Low-level S3 operations. Maps the hierarchical storage model onto flat object keys: folders are key prefixes, empty folders hold a .keep marker, and an object is stored as <key>.<extension> for one of the registered serializer extensions. Every method resolves to a ContentiaResult; none of them throw.

Constructors ​

Constructor ​

ts
new S3DataSource(config, availableExtensions): S3DataSource;

Parameters ​

ParameterType
configS3Config
availableExtensionsreadonly string[]

Returns ​

S3DataSource

Methods ​

deleteObject() ​

ts
deleteObject(key): Promise<ContentiaResult<string>>;

Delete the object behind key. S3's DELETE succeeds for missing keys too, so the object is resolved first to report a NotFoundError for keys that don't exist. Resolves to the key without extension.

Parameters ​

ParameterType
keystring

Returns ​

Promise<ContentiaResult<string>>


findObject() ​

ts
findObject(key): Promise<ContentiaResult<S3ObjectInfo | undefined>>;

HEAD the object under each registered extension and return the first hit, or undefined when no extension matches.

Parameters ​

ParameterType
keystring

Returns ​

Promise<ContentiaResult<S3ObjectInfo | undefined>>


folderExists() ​

ts
folderExists(folderKey): Promise<ContentiaResult<boolean>>;

Whether any object lives under folderKey/.

Parameters ​

ParameterType
folderKeystring

Returns ​

Promise<ContentiaResult<boolean>>


headObject() ​

ts
headObject(key): Promise<ContentiaResult<S3ObjectInfo>>;

Like findObject, but a missing object is a NotFoundError.

Parameters ​

ParameterType
keystring

Returns ​

Promise<ContentiaResult<S3ObjectInfo>>


listDirectory() ​

ts
listDirectory(folderKey): Promise<ContentiaResult<S3Entry[]>>;

List the direct children of folderKey, following continuation tokens. ListObjectsV2 never 404s: a missing prefix and an empty one both come back empty. A listing with nothing in it at all (not even a .keep marker or a console-created folder/ placeholder) is reported as a missing folder, matching the FS/WebDAV contract.

Parameters ​

ParameterType
folderKeystring

Returns ​

Promise<ContentiaResult<S3Entry[]>>


putFolderMarker() ​

ts
putFolderMarker(folderKey): Promise<ContentiaResult<void>>;

PUT an empty .keep marker so an otherwise-empty folder is listable.

Parameters ​

ParameterType
folderKeystring

Returns ​

Promise<ContentiaResult<void>>


putObject() ​

ts
putObject(
   key, 
   extension, 
   content, 
   createdAt
): Promise<ContentiaResult<void>>;

PUT <key>.<extension>, recording createdAt in user metadata.

Parameters ​

ParameterType
keystring
extensionstring
contentstring
createdAtDate

Returns ​

Promise<ContentiaResult<void>>


readObject() ​

ts
readObject(key): Promise<ContentiaResult<S3ObjectWithContent>>;

GET the object under each registered extension. One request returns both the body and its metadata, so a read never needs a separate HEAD.

Parameters ​

ParameterType
keystring

Returns ​

Promise<ContentiaResult<S3ObjectWithContent>>


stripExtension() ​

ts
stripExtension(key): string;

Strip a registered serializer extension from key, if it has one.

Parameters ​

ParameterType
keystring

Returns ​

string