@proto-kit/deployment • Docs
Documentation / @proto-kit/deployment / S3RemoteCache
Class: S3RemoteCache
Lifecycle of a SequencerModule
start(): Executed to execute any logic required to start the module
Extends
Implements
Constructors
new S3RemoteCache()
new S3RemoteCache():
S3RemoteCache
Returns
Inherited from
Properties
client?
optionalclient:Client
Defined in
deployment/src/cache/S3RemoteCache.ts:20
currentConfig
protectedcurrentConfig:undefined|S3Config
Store the config separately, so that we can apply additional checks when retrieving it via the getter
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:17
presets
staticpresets:Presets<unknown>
Inherited from
Defined in
sequencer/dist/sequencer/builder/SequencerModule.d.ts:8
Accessors
config
Get Signature
get config():
Config
Returns
Config
Set Signature
set config(
config):void
Parameters
• config: Config
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:18
Methods
create()
create(
childContainerProvider):void
Parameters
• childContainerProvider: ChildContainerProvider
Returns
void
Inherited from
Defined in
common/dist/config/ConfigurableModule.d.ts:20
getObjects()
getObjects(
program):Promise<string[]>
Parameters
• program: string
Returns
Promise<string[]>
Implementation of
Defined in
deployment/src/cache/S3RemoteCache.ts:59
readObject()
readObject(
program,object):Promise<Readable>
Parameters
• program: string
• object: string
Returns
Promise<Readable>
Implementation of
Defined in
deployment/src/cache/S3RemoteCache.ts:77
start()
start():
Promise<void>
Start the module and all it’s functionality. The returned Promise has to resolve after initialization, since it will block in the sequencer init. That means that you mustn’t await server.start() for example.
Returns
Promise<void>
Overrides
Defined in
deployment/src/cache/S3RemoteCache.ts:87
storeObject()
storeObject(
program,object,file):Promise<void>
Parameters
• program: string
• object: string
• file: Readable
Returns
Promise<void>