Interface StorageProviderConfig

Configuration options for initializing a storage provider. This interface defines the standard configuration that can be passed to initialize().

Usage Patterns

Simple Deployment (Environment Variables)

Omit accountId when using environment variables
Constructor loads credentials automatically
Call initialize() with no config or empty object

Multi-Tenant Enterprise (Database)

Provide accountId to link driver to FileStorageAccount
Include decrypted credentials from database
Or use initializeDriverWithAccountCredentials() utility

interface StorageProviderConfig {
    accountId?: string;
    accountName?: string;
    [key: string]: unknown;
}

Indexable

[key: string]: unknown
Provider-specific configuration values (e.g., API keys, bucket names, etc.).

Simple Deployment: Not needed - constructor loads from environment variables. Multi-Tenant: Provide decrypted credentials from Credential entity.

If provided, these values override the constructor defaults. If omitted, uses credentials already loaded by constructor.

Index

Properties

accountId? accountName?

Properties

`Optional`accountId

accountId?: string

The ID of the FileStorageAccount entity this driver instance is operating for. This links the driver to a specific organizational storage account.

Optional: Provide for multi-tenant mode to track account association. Omit for simple deployment using environment variables.

`Optional`accountName

accountName?: string

The name of the account (for logging/display purposes).

Optional: Useful for logging and debugging in multi-tenant scenarios.