Class S3FileSystem

Hierarchy

  • {
        _sync?: FileSystem;
        createFileSync(path: string, flag: string, mode: number): File;
        linkSync(srcpath: string, dstpath: string): void;
        mkdirSync(path: string, mode: number): void;
        openFileSync(path: string, flag: string): File;
        queueDone(): Promise<void>;
        readdirSync(path: string): string[];
        ready(): Promise<void>;
        renameSync(oldPath: string, newPath: string): void;
        rmdirSync(path: string): void;
        statSync(path: string): Stats;
        syncSync(path: string, data: Uint8Array, stats: Readonly<Stats>): void;
        unlinkSync(path: string): void;
    } & FileSystem<this>
    • S3FileSystem

Constructors

  • Parameters

    • client: S3
    • bucketName: string
    • prefix: string = ''

    Returns S3FileSystem

Properties

_disableSync?: boolean

Whether the sync cache should be disabled. Only affects async things.

_sync?: FileSystem
bucketName: string
client: S3
prefix: string

Methods

  • Create the file at path with the given mode. Then, open it with the given flag.

    Parameters

    • path: string
    • flag: string

    Returns Promise<File>

  • Parameters

    • path: string
    • flag: string
    • mode: number

    Returns File

  • Test whether or not the given path exists.

    Parameters

    • path: string

    Returns Promise<boolean>

  • Test whether or not the given path exists.

    Parameters

    • path: string

    Returns boolean

  • Asynchronous link.

    Parameters

    • _target: string
    • link: string

    Returns Promise<void>

  • Parameters

    • srcpath: string
    • dstpath: string

    Returns void

  • Get metadata about the current file system

    Returns FileSystemMetadata

  • Asynchronous mkdir.

    Parameters

    • path: string
    • mode: number

      Mode to make the directory using.

    Returns Promise<void>

  • Parameters

    • path: string
    • mode: number

    Returns void

  • Opens the file at path with the given flag. The file must exist.

    Parameters

    • path: string

      The path to open.

    • flag: string

      The flag to use when opening the file.

    Returns Promise<File>

  • Parameters

    • path: string
    • flag: string

    Returns File

  • Returns Promise<void>

  • Asynchronous readdir. Reads the contents of a directory.

    Parameters

    • path: string

    Returns Promise<string[]>

  • Parameters

    • path: string

    Returns string[]

  • Returns Promise<void>

  • Asynchronous rename.

    Parameters

    • oldPath: string
    • newPath: string

    Returns Promise<void>

  • Parameters

    • oldPath: string
    • newPath: string

    Returns void

  • Asynchronous rmdir.

    Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string

    Returns void

  • Parameters

    • path: string

    Returns Promise<Stats>

    Handle prefix

  • Parameters

    • path: string

    Returns Stats

  • Synchronize the data and stats for path asynchronously

    Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns Promise<void>

  • Parameters

    • path: string
    • data: Uint8Array
    • stats: Readonly<Stats>

    Returns void

  • Asynchronous unlink.

    Parameters

    • path: string

    Returns Promise<void>

  • Parameters

    • path: string

    Returns void