Documentation
    Preparing search index...

    Module tachyon-drive-s3

    tachyon-drive-s3

    TypeScript npm version Maintainability Code Coverage github action

    This package provides an implementation of the Tachyon Drive StorageDriver interface from the tachyon-drive package that uses AWS S3 as the underlying storage provider.

    To install this package, run the following command:

    npm install tachyon-drive-s3
    

    Usage To use this package, you first need to create an instance of the AwsS3StorageDriver class, passing in the following parameters:

    • name: A string that identifies the driver instance.
    • url: A URL object that specifies the S3 bucket and key prefix to use for storing data.
    • serializer: A function that converts data to and from a buffer.
    • processor: Optional function that processes data before it is stored and after it is retrieved.
    const awsClient = createS3Client({
    region: "us-east-1",
    endpoint: "http://localhost:9000",
    credentials: {
    accessKeyId: "accessKeyId",
    secretAccessKey: "secretAccessKey",
    },
    });
    const driver = new AwsS3StorageDriver(
    { name: "AwsS3StorageDriver", awsClient, awsBucket: "bucket", awsKey: "key" },
    bufferSerializer,
    );

    Classes

    AwsS3StorageDriver

    Type Aliases

    AwsS3StorageDriverOption