Class MinioStore

constructor

• new MinioStore(options?: MinioStoreOptions): MinioStore

  Parameters

  • options: MinioStoreOptions = {}

  Returns MinioStore

Readonlyname

Readonlylibrary

connect

• connect(): Promise<void>

  Returns Promise<void>

disconnect

• disconnect(): Promise<void>

  Returns Promise<void>

isConnected

• isConnected(): boolean

  Returns boolean

getClient

• getClient(): MinioClientLike

  Returns the underlying Minio.Client (loosely typed) for anything not wrapped here.

  Returns MinioClientLike

putObject

• putObject(
      bucket: string,
      key: string,
      data: unknown,
      options?: PutObjectOptions,
  ): Promise<PutObjectResult>

  putObject — store an object's body (and optional metadata) under bucket/key.

  Parameters

  • bucket: string
  • key: string
  • data: unknown
  • options: PutObjectOptions = {}

  Returns Promise<PutObjectResult>

getObject

• getObject(bucket: string, key: string): Promise<GetObjectResult>

  getObject — fetch an object. Minio.Client.getObject resolves to a readable byte stream; this method collects that stream to completion into a single Buffer so callers get the whole body without wiring up stream plumbing. Optionally attaches a companion statObject result.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<GetObjectResult>

removeObject

• removeObject(bucket: string, key: string): Promise<void>

  removeObject — delete an object.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<void>

listObjects

• listObjects(bucket: string, prefix?: string): Promise<string[]>

  listObjects — list objects in bucket, optionally restricted to those whose name starts with prefix. Minio.Client.listObjects returns an object stream that emits one item per object; this method collects that stream into an array of object names (item.name). Listing is recursive so nested "path"-style keys are all returned.

  Parameters

  • bucket: string
  • Optionalprefix: string

  Returns Promise<string[]>

statObject

• statObject(bucket: string, key: string): Promise<StatObjectResult>

  statObject — fetch an object's metadata without its body.

  Parameters

  • bucket: string
  • key: string

  Returns Promise<StatObjectResult>

makeBucket

• makeBucket(bucket: string, region?: string): Promise<void>

  makeBucket — create a bucket, optionally in a specific region.

  Parameters

  • bucket: string
  • Optionalregion: string

  Returns Promise<void>

bucketExists

• bucketExists(bucket: string): Promise<boolean>

  bucketExists — whether a bucket exists.

  Parameters

  • bucket: string

  Returns Promise<boolean>