Class LocalStorageAdapter

Provides a localized file system storage backend. Perfect for development or single-node deployments using local disk volumes.

Hierarchy (View Summary)

AbstractStorageAdapter
- LocalStorageAdapter

Constructors

constructor

new LocalStorageAdapter(parameters?: StorageParameters): LocalStorageAdapter
Parameters
- parameters: StorageParameters = {}
Returns LocalStorageAdapter
Overrides AbstractStorageAdapter.constructor
- Defined in storage-local/src/LocalStorageAdapter.ts:19

Properties

`Protected`_alias

_alias: string = ''

`Protected`_client

_client: any

`Protected`_params

_params: StorageParameters = {}

Methods

`Protected`_createAndUploadThumbnail

_createAndUploadThumbnail(
    file: FileType,
    size: number,
    workingDir: string,
    bucketDir: string,
    thumbnailExtension: string,
    imagePath: string,
): Promise<{ [key: string]: string }>
Parameters
- file: FileType
- size: number
- workingDir: string
- bucketDir: string
- thumbnailExtension: string
- imagePath: string
Returns Promise<{ [key: string]: string }>
Inherited from AbstractStorageAdapter._createAndUploadThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:165

`Protected`_getFileInfo

_getFileInfo(file: FileType): { bucketDir: any; extension: any; name: any }
Parameters
- file: FileType
Returns { bucketDir: any; extension: any; name: any }
Inherited from AbstractStorageAdapter._getFileInfo
- Defined in storage/src/AbstractStorageAdapter.ts:197

`Protected`_isDocumentType

_isDocumentType(file: FileType, extension: string): boolean
Parameters
- file: FileType
- extension: string
Returns boolean
Inherited from AbstractStorageAdapter._isDocumentType
- Defined in storage/src/AbstractStorageAdapter.ts:204

`Protected`_setupThumbnailWorkspace

_setupThumbnailWorkspace(workingDirName: string): Promise<string>
Parameters
- workingDirName: string
Returns Promise<string>
Inherited from AbstractStorageAdapter._setupThumbnailWorkspace
- Defined in storage/src/AbstractStorageAdapter.ts:157

copy

copy(file: FileType, destFile: FileType): Promise<any>
Copies a file from one storage path to another within the local disk.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Destination footprint.
Returns Promise<any>
A promise resolving to the new file footprint.
Overrides AbstractStorageAdapter.copy
- Defined in storage-local/src/LocalStorageAdapter.ts:82

create

create(file: FileType, stream: Readable): Promise<FileType>
Writes a streaming data source directly to the local disk.
Parameters
- file: FileType
  File footprint detailing the target path.
- stream: Readable
  Readable data stream.
Returns Promise<FileType>
A promise resolving to the saved FileType metadata.
Overrides AbstractStorageAdapter.create
- Defined in storage-local/src/LocalStorageAdapter.ts:45

delete

delete(file: FileType): Promise<boolean>
Deletes a file from the local storage volume.
Parameters
- file: FileType
  File to delete.
Returns Promise<boolean>
True if deleted, False if it didn't exist.
Overrides AbstractStorageAdapter.delete
- Defined in storage-local/src/LocalStorageAdapter.ts:124

download

download(file: FileType, destMeta: DownloadFileMetaType): Promise<any>
Downloads a stored file into a specific local directory (usually outside the storage pool).
Parameters
- file: FileType
  Original file to extract.
- destMeta: DownloadFileMetaType
  Destination tracking object.
Returns Promise<any>
A promise resolving to the downloaded file's path.

Throws
If the file doesn't exist.
Overrides AbstractStorageAdapter.download
- Defined in storage-local/src/LocalStorageAdapter.ts:64

generateDocumentThumbnail

generateDocumentThumbnail(file: FileType, sizes: number[]): Promise<any>
Extracts the first page of a document (e.g. PDF) via ImageMagick, resizes it, and uploads it as a thumbnail.
Parameters
- file: FileType
  Original document footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateDocumentThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:355

generateImageThumbnail

generateImageThumbnail(file: FileType, sizes: number[]): Promise<any>
Downloads an image, generates resized thumbnails via sharp, and uploads them back.
Parameters
- file: FileType
  Original image footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateImageThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:237

generateThumbnail

generateThumbnail(file: FileType, sizes: number[]): Promise<any>
Entry point for thumbnail generation. Analyzes the content type and automatically delegates to the appropriate generation strategy (Image, Video, or Document).
Parameters
- file: FileType
  Target file footprint.
- sizes: number[]
  Desired dimensions.
Returns Promise<any>
The generated thumbnail map, or an empty object if unsupported/failed.
Inherited from AbstractStorageAdapter.generateThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:430

generateVideoThumbnail

generateVideoThumbnail(file: FileType, sizes: number[]): Promise<any>
Extracts a single frame from a remote video via ffmpeg, resizes it, and uploads the frame as an image thumbnail.
Parameters
- file: FileType
  Original video footprint.
- sizes: number[]
  Array of desired thumbnail dimensions (px).
Returns Promise<any>
A mapping of generated thumbnail identifiers to their respective storage refs.
Inherited from AbstractStorageAdapter.generateVideoThumbnail
- Defined in storage/src/AbstractStorageAdapter.ts:285

getBucketStats

getBucketStats(bucket?: string, prefix?: string): Promise<BucketStatsType>
Computes statistics for a given bucket.
Parameters
- Optionalbucket: string
  Target bucket name.
- Optionalprefix: string
  Optional directory prefix.
Returns Promise<BucketStatsType>
A promise resolving to bucket statistics.
Inherited from AbstractStorageAdapter.getBucketStats
- Defined in storage/src/AbstractStorageAdapter.ts:153

getDriver

getDriver(): any
Provides direct access to the underlying fs-extra driver.

Returns any
The fs module wrapper.
Overrides AbstractStorageAdapter.getDriver
- Defined in storage-local/src/LocalStorageAdapter.ts:30

getMetaData

getMetaData(file: FileType): Promise<FileType>
Retrieves basic filesystem metadata (like file size) for the specified file.
Parameters
- file: FileType
  The target file reference.
Returns Promise<FileType>
A promise resolving to the file object augmented with its actual byte size.
Overrides AbstractStorageAdapter.getMetaData
- Defined in storage-local/src/LocalStorageAdapter.ts:173

getReadable

getReadable(file: FileType): Promise<Readable>
Initializes a Node.js Readable stream from the disk file.
Parameters
- file: FileType
  Target file.
Returns Promise<Readable>
A promise resolving to the ReadStream.
Overrides AbstractStorageAdapter.getReadable
- Defined in storage-local/src/LocalStorageAdapter.ts:162

getUploadUrl

getUploadUrl(filePath: FileType, expiresIn?: number): Promise<any>
Bypasses standard web upload links by returning a local URI for manual OS placement.
Parameters
- filePath: FileType
  The target file.
- OptionalexpiresIn: number
  Ignored.
Returns Promise<any>
A promise resolving to the file URI string.
Overrides AbstractStorageAdapter.getUploadUrl
- Defined in storage-local/src/LocalStorageAdapter.ts:152

getUrl

getUrl(
    file: FileType,
    expiresIn?: number,
    action?: string,
    extra?: any,
): Promise<any>
Generates a local file:// URI protocol link for system interoperability.
Parameters
- file: FileType
  Target file.
- OptionalexpiresIn: number
  Ignored for local files.
- Optionalaction: string
  Ignored.
- Optionalextra: any
  Ignored.
Returns Promise<any>
A promise resolving to the local file URI string.
Overrides AbstractStorageAdapter.getUrl
- Defined in storage-local/src/LocalStorageAdapter.ts:114

`Protected`isVideoOrAudio

isVideoOrAudio(file: FileType): boolean
Checks if the file is a video or audio stream based on its MIME type or file extension.
Parameters
- file: FileType
  Target file.
Returns boolean
True if the file represents a video or audio asset.
Inherited from AbstractStorageAdapter.isVideoOrAudio
- Defined in storage/src/AbstractStorageAdapter.ts:485

move

move(file: FileType, destFile: FileType): Promise<any>
Moves a file from one storage path to another within the local disk.
Parameters
- file: FileType
  Source footprint.
- destFile: FileType
  Target footprint.
Returns Promise<any>
A promise resolving to the relocated file footprint.
Overrides AbstractStorageAdapter.move
- Defined in storage-local/src/LocalStorageAdapter.ts:97

stream

stream(file: FileType, res: any): Promise<any>
Creates a read stream and directly pipes it to an output (e.g. an HTTP response).
Parameters
- file: FileType
  File to stream.
- res: any
  The writable destination pipe.
Returns Promise<any>
Overrides AbstractStorageAdapter.stream
- Defined in storage-local/src/LocalStorageAdapter.ts:139

Class LocalStorageAdapter

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns LocalStorageAdapter

Properties

Protected_alias

Protected_client

Protected_params

Methods

Protected_createAndUploadThumbnail

Parameters

Returns Promise<{ [key: string]: string }>

Protected_getFileInfo

Parameters

Returns { bucketDir: any; extension: any; name: any }

Protected_isDocumentType

Parameters

Returns boolean

Protected_setupThumbnailWorkspace

Parameters

Returns Promise<string>

copy

Parameters

Returns Promise<any>

create

Parameters

Returns Promise<FileType>

delete

Parameters

Returns Promise<boolean>

download

Parameters

Returns Promise<any>

Throws

generateDocumentThumbnail

Parameters

Returns Promise<any>

generateImageThumbnail

Parameters

Returns Promise<any>

generateThumbnail

Parameters

Returns Promise<any>

generateVideoThumbnail

Parameters

Returns Promise<any>

getBucketStats

Parameters

Returns Promise<BucketStatsType>

getDriver

Returns any

getMetaData

Parameters

Returns Promise<FileType>

getReadable

Parameters

Returns Promise<Readable>

getUploadUrl

Parameters

Returns Promise<any>

getUrl

Parameters

Returns Promise<any>

ProtectedisVideoOrAudio

Parameters

Returns boolean

move

Parameters

Returns Promise<any>

stream

Parameters

Returns Promise<any>

Settings

On This Page

`Protected`_alias

`Protected`_client

`Protected`_params

`Protected`_createAndUploadThumbnail

`Protected`_getFileInfo

`Protected`_isDocumentType

`Protected`_setupThumbnailWorkspace

`Protected`isVideoOrAudio