Setu-TS
    Preparing search index...

    Interface IS3Backend

    The S3 BACKEND surface this package drives — not an @aws-sdk/client-s3 client.

    Renamed from IAwsS3Client because that name, and the docs around it, promised something it never was: the real SDK's surface is send(command), so injecting an actual S3Client was rejected with Injected S3 client is missing required methods (X8-10). What this declares is the shape adaptAwsS3Module PRODUCES from the SDK, so an application supplying it is implementing the backend, not swapping in a pre-configured client.

    That makes it useful for a test double or a wholly different backend, and NOT a way to configure the underlying SDK client — there is no path today for a custom retry policy, timeout or proxy agent.

    0.1.0

    interface IS3Backend {
        delete(path: string): Promise<boolean>;
        get(path: string): Promise<Uint8Array<ArrayBufferLike> | null>;
        getSignedUrl(path: string, expiresIn: number): Promise<string>;
        getStream(
            path: string,
        ): Promise<ReadableStream<Uint8Array<ArrayBufferLike>> | null>;
        head(path: string): Promise<boolean>;
        put(
            path: string,
            data: Uint8Array,
            options?: PutObjectOptions,
        ): Promise<void>;
    }
    Index
    delete get getSignedUrl getStream head put

    Settings
    Member Visibility

    On This Page
    Methods