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
new S3DataSource(config, availableExtensions): S3DataSource;Parameters
| Parameter | Type |
|---|---|
config | S3Config |
availableExtensions | readonly string[] |
Returns
S3DataSource
Methods
deleteObject()
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
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<ContentiaResult<string>>
findObject()
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
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<ContentiaResult<S3ObjectInfo | undefined>>
folderExists()
folderExists(folderKey): Promise<ContentiaResult<boolean>>;Whether any object lives under folderKey/.
Parameters
| Parameter | Type |
|---|---|
folderKey | string |
Returns
Promise<ContentiaResult<boolean>>
headObject()
headObject(key): Promise<ContentiaResult<S3ObjectInfo>>;Like findObject, but a missing object is a NotFoundError.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<ContentiaResult<S3ObjectInfo>>
listDirectory()
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
| Parameter | Type |
|---|---|
folderKey | string |
Returns
Promise<ContentiaResult<S3Entry[]>>
putFolderMarker()
putFolderMarker(folderKey): Promise<ContentiaResult<void>>;PUT an empty .keep marker so an otherwise-empty folder is listable.
Parameters
| Parameter | Type |
|---|---|
folderKey | string |
Returns
Promise<ContentiaResult<void>>
putObject()
putObject(
key,
extension,
content,
createdAt
): Promise<ContentiaResult<void>>;PUT <key>.<extension>, recording createdAt in user metadata.
Parameters
| Parameter | Type |
|---|---|
key | string |
extension | string |
content | string |
createdAt | Date |
Returns
Promise<ContentiaResult<void>>
readObject()
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
| Parameter | Type |
|---|---|
key | string |
Returns
Promise<ContentiaResult<S3ObjectWithContent>>
stripExtension()
stripExtension(key): string;Strip a registered serializer extension from key, if it has one.
Parameters
| Parameter | Type |
|---|---|
key | string |
Returns
string