Interface S3Bucket

interface S3Bucket {
    name: "S3";
    options: {
        bucketName: {
            description: "The name of the bucket you want to use";
            required: true;
            type: "string";
        };
        client: {
            description: "Authenticated S3 client";
            required: true;
            type: "object";
        };
        prefix: {
            description: "The prefix to use for all operations";
            required: false;
            type: "string";
        };
    };
    create(__namedParameters: S3Options): S3FileSystem;
    isAvailable(): boolean;
}

Hierarchy

  • _S3Bucket
    • S3Bucket

Properties

name options

Methods

create isAvailable

Properties

Readonlyname

name: "S3" = 'S3'

Readonlyoptions

options: {
    bucketName: {
        description: "The name of the bucket you want to use";
        required: true;
        type: "string";
    };
    client: {
        description: "Authenticated S3 client";
        required: true;
        type: "object";
    };
    prefix: {
        description: "The prefix to use for all operations";
        required: false;
        type: "string";
    };
} = ...

Methods

Readonlycreate

ReadonlyisAvailable

  • isAvailable(): boolean

  • Returns boolean

Settings

Member Visibility

On This Page

Properties
Methods