Minima.js API

---

Minima.js API / @minimajs/disk / adapters / FsDriver

Class: FsDriver

Filesystem storage driver for @minimajs/disk

Implements

• DiskDriver

Constructors

Constructor

new FsDriver(options): FsDriver;

Parameters

options

FsDriverBaseOptions

Returns

FsDriver

Properties

name

readonly name: "fs" = "fs";

Driver name (e.g., 'fs', 's3', 'azure')

Implementation of

DiskDriver.name

Accessors

[toStringTag]

Get Signature

get toStringTag: string;

Returns

string

---

capabilities

Get Signature

get capabilities(): DriverCapabilities;

Optional capability declarations — see DriverCapabilities

Returns

DriverCapabilities

Optional capability declarations — see DriverCapabilities

Implementation of

DiskDriver.capabilities

Methods

[custom]()

custom: {
  [toStringTag]: string;
  name: string;
  publicUrl: string | undefined;
  root: string;
  sidecarMetadata: boolean;
};

Returns

{
  [toStringTag]: string;
  name: string;
  publicUrl: string | undefined;
  root: string;
  sidecarMetadata: boolean;
}

[toStringTag]

[toStringTag]: string = "FsDriver";

name

name: string;

publicUrl

publicUrl: string | undefined;

root

root: string;

sidecarMetadata

sidecarMetadata: boolean;

---

copy()

copy(from, to): Promise<void>;

Copy a file to a new location

Parameters

from

string

Source absolute URL/URI

to

string

Destination absolute URL/URI

Returns

Promise<void>

Implementation of

DiskDriver.copy

---

delete()

delete(href): Promise<void>;

Delete file by href

Parameters

href

string

Absolute URL/URI with protocol

Returns

Promise<void>

Implementation of

DiskDriver.delete

---

exists()

exists(href): Promise<boolean>;

Check if file exists

Parameters

href

string

Absolute URL/URI with protocol

Returns

Promise<boolean>

Implementation of

DiskDriver.exists

---

get()

get(href): Promise<
  | [ReadableStream<Uint8Array<ArrayBufferLike>>, FileMetadata]
| null>;

Retrieve file as a ReadableStream with metadata

Parameters

href

string

Absolute URL/URI with protocol

Returns

Promise< | [ReadableStream<Uint8Array<ArrayBufferLike>>, FileMetadata] | null>

Tuple of [stream, metadata] or null if not found

Implementation of

DiskDriver.get

---

list()

list(prefix, listOptions?): AsyncIterable<FileMetadata>;

List files under a prefix href.

Parameters

prefix

string

Absolute href prefix ending with /, or "" to list everything.

listOptions?

ListOptions

Pagination options

Returns

AsyncIterable<FileMetadata>

Implementation of

DiskDriver.list

---

metadata()

metadata(href): Promise<
  | FileMetadata
| null>;

Get file metadata without content

Parameters

href

string

Absolute URL/URI with protocol

Returns

Promise< | FileMetadata | null>

Implementation of

DiskDriver.metadata

---

move()

move(from, to): Promise<void>;

Move a file to a new location

Parameters

from

string

Source absolute URL/URI

to

string

Destination absolute URL/URI

Returns

Promise<void>

Implementation of

DiskDriver.move

---

put()

put(
   href, 
   stream, 
putOptions): Promise<FileMetadata>;

Store data from a ReadableStream

Parameters

href

string

Absolute URL/URI with protocol

stream

ReadableStream<Uint8Array<ArrayBufferLike>>

ReadableStream of data to store

putOptions

PutOptions

Optional metadata and content type

Returns

Promise<FileMetadata>

FileMetadata about the stored file

Implementation of

DiskDriver.put

---

storageInfo()

storageInfo(): Promise<StorageInfo>;

Returns

Promise<StorageInfo>

---

url()

url(href, _urlOptions?): Promise<string>;

Generate a URL for the file

Parameters

href

string

Absolute URL/URI with protocol

_urlOptions?

UrlOptions

URL options (expiration, download disposition)

Returns

Promise<string>

Implementation of

DiskDriver.url

---

watch()

watch(pattern, options?): Promise<FSWatcher>;

Watch files for changes using chokidar

Parameters

pattern

string

options?

WatchOptions

Returns

Promise<FSWatcher>

Implementation of

DiskDriver.watch