Class S3Storage

Implements

IBlobStorage

Index

Constructors

Properties

bucket client log objects publicURL

Methods

createObjectName getBlobObject getBlobSize getBlobType hasBlob listBlobs loadObjects readBlob removeBlob setup writeBlob

Constructors

constructor

new S3Storage(endpoint, accessKey, secretKey, bucket, options?): S3Storage
Parameters
- endpoint: string
- accessKey: string
- secretKey: string
- bucket: string
- Optional options: S3StorageOptions
Returns S3Storage
- Defined in storage/s3.ts:22

Properties

bucket

bucket: string

client

client: Client

log

log: Debugger = ...

objects

objects: {
name: string;
size: number;
}[] = []

cached array of objects that are stored in the s3 bucket

Type declaration

name: string
size: number

publicURL

publicURL: undefined | string = undefined

Methods

`Private` createObjectName

createObjectName(sha256, type?): string
Parameters
- sha256: string
- Optional type: string
Returns string
- Defined in storage/s3.ts:61

`Private` getBlobObject

getBlobObject(sha256): undefined | {
name: string;
size: number;
}
Parameters
- sha256: string
Returns undefined | {
name: string;
size: number;
}
- Defined in storage/s3.ts:58

getBlobSize

getBlobSize(sha256): Promise<number>
get the size of the stored blob
Parameters
- sha256: string
Returns Promise<number>
Implementation of IBlobStorage.getBlobSize
- Defined in storage/s3.ts:102

getBlobType

getBlobType(sha256): undefined | string | Promise<undefined | string>
get the MIME type of the blob if the storage knows it
Parameters
- sha256: string
Returns undefined | string | Promise<undefined | string>
Implementation of IBlobStorage.getBlobType
- Defined in storage/s3.ts:107

hasBlob

hasBlob(sha256): Promise<boolean>
check if blob exists in storage
Parameters
- sha256: string
Returns Promise<boolean>
Implementation of IBlobStorage.hasBlob
- Defined in storage/s3.ts:66

listBlobs

listBlobs(): Promise<string[]>
lists all hashes

Returns Promise<string[]>
Implementation of IBlobStorage.listBlobs
- Defined in storage/s3.ts:69

`Private` loadObjects

loadObjects(): Promise<void>
Returns Promise<void>
- Defined in storage/s3.ts:39

readBlob

readBlob(sha256): Promise<Readable>
returns the blob contents as a Readable stream
Parameters
- sha256: string
Returns Promise<Readable>
Implementation of IBlobStorage.readBlob
- Defined in storage/s3.ts:114

removeBlob

removeBlob(sha256): Promise<void>
remove a blob from storage
Parameters
- sha256: string
Returns Promise<void>
Implementation of IBlobStorage.removeBlob
- Defined in storage/s3.ts:119

setup

setup(): Promise<void>
setup storage

Returns Promise<void>
Implementation of IBlobStorage.setup
- Defined in storage/s3.ts:50

writeBlob

writeBlob(sha256, stream, type?): Promise<void>
save blob
Parameters
- sha256: string
- stream: Readable | Buffer
- Optional type: string
Returns Promise<void>
Implementation of IBlobStorage.writeBlob
- Defined in storage/s3.ts:77