Class StorageService

Storage Service

Main facade for storage operations. Request-scoped for proper isolation.

Example

@inject(STORAGE_TOKENS.StorageService)
private readonly storage: StorageService

await this.storage.upload(file, 'documents/report.pdf')

Hierarchy (View Summary)

StorageService
- FakeStorageService

Index

Constructors

constructor

new StorageService(
storageManager: StorageManagerService,
options: StorageConfig,
): StorageService
Parameters
- storageManager: StorageManagerService
- options: StorageConfig
Returns StorageService
- Defined in packages/core/src/storage/services/storage.service.ts:31

Properties

`Protected` `Readonly`options

options: StorageConfig

`Protected` `Readonly`storageManager

storageManager: StorageManagerService

Methods

`Protected`buildFullPath

buildFullPath(relativePath: string, diskName: string): string
Build full path with disk root and path template substitution
Parameters
- relativePath: string
  Relative path within the disk
- diskName: string
  Name of the disk
Returns string
Full path including disk root
- Defined in packages/core/src/storage/services/storage.service.ts:188

chunkedUpload

chunkedUpload(
    body: StreamingBlobPayloadInputTypes | undefined,
    relativePath: string,
    options: Omit<UploadOptions, "size"> & { size?: number },
    disk?: string,
): Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Chunked upload for streaming data without known size Uses multipart upload under the hood - handles retries and large files

Use this method when:
- Content-Length is unknown or unreliable
- Uploading from streams that can't be rewound
- Need automatic retry handling for transient failures
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
  Content to upload (stream or buffer)
- relativePath: string
  Relative path within the disk
- options: Omit<UploadOptions, "size"> & { size?: number }
  Upload options (mimeType required, size optional)
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload result with metadata
- Defined in packages/core/src/storage/services/storage.service.ts:263

delete

delete(relativePath: string, disk?: string): Promise<void>
Delete a file from storage
Parameters
- relativePath: string
  Relative path within the disk
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<void>
- Defined in packages/core/src/storage/services/storage.service.ts:78

download

download(relativePath: string, disk?: string): Promise<DownloadResult>
Download a file from storage
Parameters
- relativePath: string
  Relative path within the disk
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<DownloadResult>
Download result with stream and metadata
- Defined in packages/core/src/storage/services/storage.service.ts:65

exists

exists(relativePath: string, disk?: string): Promise<boolean>
Check if a file exists in storage
Parameters
- relativePath: string
  Relative path within the disk
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<boolean>
True if file exists, false otherwise
- Defined in packages/core/src/storage/services/storage.service.ts:92

getAvailableDisks

getAvailableDisks(): string[]
Get all available disk names

Returns string[]
Array of disk names
- Defined in packages/core/src/storage/services/storage.service.ts:244

getPresignedDeleteUrl

getPresignedDeleteUrl(
    relativePath: string,
    expiresIn?: number,
    disk?: string,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a presigned delete URL
Parameters
- relativePath: string
  Relative path within the disk
- OptionalexpiresIn: number
  Optional expiry time in seconds (uses default if not provided)
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Presigned URL result
- Defined in packages/core/src/storage/services/storage.service.ts:137

getPresignedDownloadUrl

getPresignedDownloadUrl(
    relativePath: string,
    expiresIn?: number,
    disk?: string,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a presigned download URL
Parameters
- relativePath: string
  Relative path within the disk
- OptionalexpiresIn: number
  Optional expiry time in seconds (uses default if not provided)
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Presigned URL result
- Defined in packages/core/src/storage/services/storage.service.ts:107

getPresignedUploadUrl

getPresignedUploadUrl(
    relativePath: string,
    expiresIn?: number,
    disk?: string,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a presigned upload URL
Parameters
- relativePath: string
  Relative path within the disk
- OptionalexpiresIn: number
  Optional expiry time in seconds (uses default if not provided)
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Presigned URL result
- Defined in packages/core/src/storage/services/storage.service.ts:122

`Protected`getPresignedUrl

getPresignedUrl(
    relativePath: string,
    method: "GET" | "PUT" | "DELETE" | "HEAD",
    expiresIn?: number,
    disk?: string,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a presigned URL for any method
Parameters
- relativePath: string
  Relative path within the disk
- method: "GET" | "PUT" | "DELETE" | "HEAD"
  HTTP method (GET, PUT, DELETE, HEAD)
- OptionalexpiresIn: number
  Optional expiry time in seconds (uses default if not provided)
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Presigned URL result
- Defined in packages/core/src/storage/services/storage.service.ts:153

`Protected`resolveDisk

resolveDisk(disk?: string): string
Resolve disk name (use default if not provided)
Parameters
- Optionaldisk: string
  Optional disk name
Returns string
Resolved disk name
- Defined in packages/core/src/storage/services/storage.service.ts:172

`Protected`substituteTemplateVariables

substituteTemplateVariables(path: string): string
Substitute template variables in path Override this method in subclasses to add custom substitutions
Parameters
- path: string
  Path with template variables
Returns string
Path with substituted variables
- Defined in packages/core/src/storage/services/storage.service.ts:208

upload

upload(
    body: StreamingBlobPayloadInputTypes | undefined,
    relativePath: string,
    options: UploadOptions,
    disk?: string,
): Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload content to storage
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
  Content to upload (stream, buffer, or string)
- relativePath: string
  Relative path within the disk
- options: UploadOptions
  Upload options including size and mime type
- Optionaldisk: string
  Optional disk name (uses default if not provided)
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Upload result with metadata
- Defined in packages/core/src/storage/services/storage.service.ts:46

`Protected`validateExpiresIn

validateExpiresIn(expiresIn?: number): number
Validate expiry time for presigned URLs
Parameters
- OptionalexpiresIn: number
  Optional expiry time in seconds
Returns number
Validated expiry time
- Defined in packages/core/src/storage/services/storage.service.ts:225

Class StorageService

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns StorageService

Properties

Protected Readonlyoptions

Protected ReadonlystorageManager

Methods

ProtectedbuildFullPath

Parameters

Returns string

chunkedUpload

Parameters

Returns Promise< { disk: string; fullPath: string; mimeType: string; path: string; size: number; uploadedAt: Date; },>

delete

Parameters

Returns Promise<void>

download

Parameters

Returns Promise<DownloadResult>

exists

Parameters

Returns Promise<boolean>

getAvailableDisks

Returns string[]

getPresignedDeleteUrl

Parameters

Returns Promise< { expiresAt: Date; expiresIn: number; method: "GET" | "PUT" | "DELETE" | "HEAD"; url: string; },>

getPresignedDownloadUrl

Parameters

Returns Promise< { expiresAt: Date; expiresIn: number; method: "GET" | "PUT" | "DELETE" | "HEAD"; url: string; },>

getPresignedUploadUrl

Parameters

Returns Promise< { expiresAt: Date; expiresIn: number; method: "GET" | "PUT" | "DELETE" | "HEAD"; url: string; },>

ProtectedgetPresignedUrl

Parameters

Returns Promise< { expiresAt: Date; expiresIn: number; method: "GET" | "PUT" | "DELETE" | "HEAD"; url: string; },>

ProtectedresolveDisk

Parameters

Returns string

ProtectedsubstituteTemplateVariables

Parameters

Returns string

upload

Parameters

Returns Promise< { disk: string; fullPath: string; mimeType: string; path: string; size: number; uploadedAt: Date; },>

ProtectedvalidateExpiresIn

Parameters

Returns number

Settings

On This Page

`Protected` `Readonly`options

`Protected` `Readonly`storageManager

`Protected`buildFullPath

Returns Promise<
{
disk: string;
fullPath: string;
mimeType: string;
path: string;
size: number;
uploadedAt: Date;
},
>

Returns Promise<
{
expiresAt: Date;
expiresIn: number;
method: "GET"
| "PUT"
| "DELETE"
| "HEAD";
url: string;
},
>

Returns Promise<
{
expiresAt: Date;
expiresIn: number;
method: "GET"
| "PUT"
| "DELETE"
| "HEAD";
url: string;
},
>

Returns Promise<
{
expiresAt: Date;
expiresIn: number;
method: "GET"
| "PUT"
| "DELETE"
| "HEAD";
url: string;
},
>

`Protected`getPresignedUrl

Returns Promise<
{
expiresAt: Date;
expiresIn: number;
method: "GET"
| "PUT"
| "DELETE"
| "HEAD";
url: string;
},
>

`Protected`resolveDisk

`Protected`substituteTemplateVariables

Returns Promise<
{
disk: string;
fullPath: string;
mimeType: string;
path: string;
size: number;
uploadedAt: Date;
},
>

`Protected`validateExpiresIn