Options
All
  • Public
  • Public/Protected
  • All
Menu

Class MinioS3Adapter

An adapter for Amazon S3 compatible storage.

Hierarchy

  • MinioS3Adapter

Implements

  • Adapter

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

Readonly bucketCache

bucketCache: Set<string>

The set of encountered buckets.

createIfNotExist

createIfNotExist: boolean

Whether to create a bucket if it does not yet exist.

flushEnabled

flushEnabled: boolean

Enable or disable flushing the file system.

handle

handle: "minio-s3"

The handle for this adapter, basically an id. Should be something simple but descriptive, like 'node-fs' or 'blob'.

Readonly include

include: Matcher

The file globs to apply to snapshot and flush operations.

journal

journal: Journal<MinioS3JournalEntry>

Log useful messages to the journal about file operations.

Readonly minioClient

minioClient: Client

The backing instance of MinIO client.

Readonly minioOptions

minioOptions: ClientOptions

The backing options for MinIO client.

Optional Readonly region

region: string

The region to create new buckets in.

Readonly root

root: string

The real root of this file system which will be committed to.

Accessors

isGlobal

  • get isGlobal(): boolean

Methods

flush

  • flush(): Promise<void>

Private getBucket

  • getBucket(name: string, op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read", exists?: boolean): Promise<string>

link

  • link(linkPath: string, linkTarget: string, type: LinkType): Promise<void>

Private listBuckets

  • listBuckets(op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): AsyncGenerator<string, any, unknown>

  • List the buckets for this instance and optionally cache them.

    Parameters

    • op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"

    Returns AsyncGenerator<string, any, unknown>

Private listObjects

  • listObjects(name: string, op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): AsyncGenerator<BucketItem, any, unknown>

mkdir

  • mkdir(path: string): Promise<void>

read

  • read(path: string): Promise<Buffer>

Private readObject

  • readObject(bucketName: string, objectName: string, op: "snapshot" | "write" | "mkdir" | "link" | "remove" | "flush" | "read"): Promise<Buffer>

remove

  • remove(path: string, type: ItemType): Promise<void>

snapshot

  • snapshot(): AsyncGenerator<[string, SnapshotEntry], any, unknown>

  • Snapshot of the underlying file system; an asynchronous iterable which returns an entry of path and data.

    Returns AsyncGenerator<[string, SnapshotEntry], any, unknown>

    The asynchronous iterable to get the snapshot.

write

  • write(path: string, contents?: Buffer): Promise<void>

Generated using TypeDoc