@valon-technologies/gestalt
    Preparing search index...

    Runtime hooks required to implement a Gestalt S3 provider.

    interface S3ProviderOptions {
        name?: string;
        displayName?: string;
        description?: string;
        version?: string;
        configure?: ConfigureHandler;
        healthCheck?: HealthCheckHandler;
        warnings?: string[] | WarningsHandler;
        start?: StartHandler;
        close?: CloseHandler;
        headObject: (ref: ObjectRef) => MaybePromise<ObjectMeta>;
        readObject: (
            ref: ObjectRef,
            options?: ReadOptions,
        ) => MaybePromise<ProviderReadResult>;
        writeObject: (
            ref: ObjectRef,
            body: AsyncIterable<Uint8Array<ArrayBufferLike>>,
            options?: WriteOptions,
        ) => MaybePromise<ObjectMeta>;
        deleteObject: (ref: ObjectRef) => MaybePromise<void>;
        listObjects: (options: ListOptions) => MaybePromise<ListPage>;
        copyObject: (
            source: ObjectRef,
            destination: ObjectRef,
            options?: CopyOptions,
        ) => MaybePromise<ObjectMeta>;
        presignObject: (
            ref: ObjectRef,
            options?: PresignOptions,
        ) => MaybePromise<PresignResult>;
    }

    Hierarchy (View Summary)

    Index

    Properties

    name?: string
    displayName?: string
    description?: string
    version?: string
    configure?: ConfigureHandler
    healthCheck?: HealthCheckHandler
    warnings?: string[] | WarningsHandler
    start?: StartHandler
    close?: CloseHandler
    headObject: (ref: ObjectRef) => MaybePromise<ObjectMeta>
    readObject: (
        ref: ObjectRef,
        options?: ReadOptions,
    ) => MaybePromise<ProviderReadResult>
    writeObject: (
        ref: ObjectRef,
        body: AsyncIterable<Uint8Array<ArrayBufferLike>>,
        options?: WriteOptions,
    ) => MaybePromise<ObjectMeta>
    deleteObject: (ref: ObjectRef) => MaybePromise<void>
    listObjects: (options: ListOptions) => MaybePromise<ListPage>
    copyObject: (
        source: ObjectRef,
        destination: ObjectRef,
        options?: CopyOptions,
    ) => MaybePromise<ObjectMeta>
    presignObject: (
        ref: ObjectRef,
        options?: PresignOptions,
    ) => MaybePromise<PresignResult>