Class FakeStorageService

FakeStorageService

In-memory storage implementation for testing. Registered by default in TestingModuleBuilder.

Similar to Laravel's Storage::fake() - stores files in memory and provides assertion helpers for testing.

Example

// Access via TestingModule
module.storage.assertExists('path/to/file.pdf')
module.storage.assertMissing('deleted/file.pdf')
module.storage.clear() // Reset between tests

Hierarchy (View Summary)

StorageService
- FakeStorageService

Constructors

constructor

new FakeStorageService(
storageManager: StorageManagerService,
options: StorageConfig,
): FakeStorageService
Parameters
- storageManager: StorageManagerService
- options: StorageConfig
Returns FakeStorageService
Overrides StorageService.constructor
- Defined in packages/testing/src/storage/fake-storage.service.ts:48

Properties

`Protected` `Readonly`options

options: StorageConfig

`Protected` `Readonly`storageManager

storageManager: StorageManagerService

Methods

assertCount

assertCount(count: number): void
Assert storage has exactly N files
Parameters
- count: number
  Expected number of files
Returns void
Throws
AssertionError if count doesn't match
- Defined in packages/testing/src/storage/fake-storage.service.ts:220

assertEmpty

assertEmpty(): void
Assert storage is empty

Returns void
Throws
AssertionError if any files exist
- Defined in packages/testing/src/storage/fake-storage.service.ts:207

assertExists

assertExists(path: string): void
Assert that a file exists at the given path
Parameters
- path: string
  Path to check
Returns void
Throws
AssertionError if file does not exist
- Defined in packages/testing/src/storage/fake-storage.service.ts:182

assertMissing

assertMissing(path: string): void
Assert that a file does NOT exist at the given path
Parameters
- path: string
  Path to check
Returns void
Throws
AssertionError if file exists
- Defined in packages/testing/src/storage/fake-storage.service.ts:195

`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
Inherited from StorageService.buildFullPath
- Defined in packages/core/dist/storage/services/storage.service.d.ts:98

chunkedUpload

chunkedUpload(
    body: StreamingBlobPayloadInputTypes | undefined,
    path: string,
    options: Omit<UploadOptions, "size"> & { size?: number },
    disk?: string,
): Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Chunked upload (same as regular upload for fake)
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
- path: string
- options: Omit<UploadOptions, "size"> & { size?: number }
- Optionaldisk: string
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Overrides StorageService.chunkedUpload
- Defined in packages/testing/src/storage/fake-storage.service.ts:160

clear

clear(): void
Clear all stored files (call in beforeEach for test isolation)

Returns void
- Defined in packages/testing/src/storage/fake-storage.service.ts:251

delete

delete(path: string): Promise<void>
Delete a file from fake storage
Parameters
- path: string
Returns Promise<void>
Overrides StorageService.delete
- Defined in packages/testing/src/storage/fake-storage.service.ts:115

download

download(path: string): Promise<DownloadResult>
Download a file from fake storage
Parameters
- path: string
Returns Promise<DownloadResult>
Overrides StorageService.download
- Defined in packages/testing/src/storage/fake-storage.service.ts:90

exists

exists(path: string): Promise<boolean>
Check if a file exists in fake storage
Parameters
- path: string
Returns Promise<boolean>
Overrides StorageService.exists
- Defined in packages/testing/src/storage/fake-storage.service.ts:123

getAvailableDisks

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

Returns string[]
Array of disk names
Inherited from StorageService.getAvailableDisks
- Defined in packages/core/dist/storage/services/storage.service.d.ts:117

getFile

getFile(path: string): StoredFile | undefined
Get a specific file by path
Parameters
- path: string
Returns StoredFile | undefined
- Defined in packages/testing/src/storage/fake-storage.service.ts:244

getPresignedDeleteUrl

getPresignedDeleteUrl(
    path: string,
    expiresIn?: number,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a fake presigned delete URL
Parameters
- path: string
- OptionalexpiresIn: number
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Overrides StorageService.getPresignedDeleteUrl
- Defined in packages/testing/src/storage/fake-storage.service.ts:150

getPresignedDownloadUrl

getPresignedDownloadUrl(
    path: string,
    expiresIn?: number,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a fake presigned download URL
Parameters
- path: string
- OptionalexpiresIn: number
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Overrides StorageService.getPresignedDownloadUrl
- Defined in packages/testing/src/storage/fake-storage.service.ts:130

getPresignedUploadUrl

getPresignedUploadUrl(
    path: string,
    expiresIn?: number,
): Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Generate a fake presigned upload URL
Parameters
- path: string
- OptionalexpiresIn: number
Returns Promise<
    {
        expiresAt: Date;
        expiresIn: number;
        method: "GET"
        | "PUT"
        | "DELETE"
        | "HEAD";
        url: string;
    },
>
Overrides StorageService.getPresignedUploadUrl
- Defined in packages/testing/src/storage/fake-storage.service.ts:140

`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
Inherited from StorageService.getPresignedUrl
- Defined in packages/core/dist/storage/services/storage.service.d.ts:85

getStoredFiles

getStoredFiles(): Map<string, StoredFile>
Get all stored files (for inspection)

Returns Map<string, StoredFile>
- Defined in packages/testing/src/storage/fake-storage.service.ts:230

getStoredPaths

getStoredPaths(): string[]
Get all stored file paths

Returns string[]
- Defined in packages/testing/src/storage/fake-storage.service.ts:237

`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
Inherited from StorageService.resolveDisk
- Defined in packages/core/dist/storage/services/storage.service.d.ts:91

`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
Inherited from StorageService.substituteTemplateVariables
- Defined in packages/core/dist/storage/services/storage.service.d.ts:106

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 fake storage
Parameters
- body: StreamingBlobPayloadInputTypes | undefined
- relativePath: string
- options: UploadOptions
- Optionaldisk: string
Returns Promise<
    {
        disk: string;
        fullPath: string;
        mimeType: string;
        path: string;
        size: number;
        uploadedAt: Date;
    },
>
Overrides StorageService.upload
- Defined in packages/testing/src/storage/fake-storage.service.ts:60

`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
Inherited from StorageService.validateExpiresIn
- Defined in packages/core/dist/storage/services/storage.service.d.ts:112

Class FakeStorageService

Example

Hierarchy (View Summary)

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns FakeStorageService

Properties

Protected Readonlyoptions

Protected ReadonlystorageManager

Methods

assertCount

Parameters

Returns void

Throws

assertEmpty

Returns void

Throws

assertExists

Parameters

Returns void

Throws

assertMissing

Parameters

Returns void

Throws

ProtectedbuildFullPath

Parameters

Returns string

chunkedUpload

Parameters

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

clear

Returns void

delete

Parameters

Returns Promise<void>

download

Parameters

Returns Promise<DownloadResult>

exists

Parameters

Returns Promise<boolean>

getAvailableDisks

Returns string[]

getFile

Parameters

Returns StoredFile | undefined

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; },>

getStoredFiles

Returns Map<string, StoredFile>

getStoredPaths

Returns 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

`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