Storage

Register StorageServiceProvider and add config/storage.ts:

export default {
  default: 'local',
  disks: {
    local: {
      driver: 'local',
      root: storage_path('app'),
    },
    public: {
      driver: 'local',
      root: public_path('storage'),
    },
  },
} as const;

Using the Storage facade

import { Storage } from '@tyravel/core';

// Write a file
await Storage.put('avatars/ada.png', imageBuffer);

// Read a file — returns Buffer or null
const data = await Storage.get('reports/summary.csv');

// Check existence
const exists = await Storage.exists('avatars/ada.png');

// Delete a file
await Storage.delete('temp/old-file.txt');

// Get a public URL
const url = Storage.url('avatars/ada.png');
// => /avatars/ada.png

Multiple disks

Configure multiple disks and switch between them:

export default {
  default: 'local',
  disks: {
    local: { driver: 'local', root: storage_path('app') },
    public: { driver: 'local', root: public_path('storage') },
    photos: { driver: 'local', root: '/mnt/photos' },
  },
} as const;

Use a specific disk:

// Using the facade
const url = Storage.disk('public').url('avatars/ada.png');

// Or via StorageManager directly
import { StorageManager } from '@tyravel/storage';

const manager = app.make(StorageManager);
const disk = manager.disk('photos');
await disk.put('2025/sunset.jpg', buffer);

Custom drivers

Register custom storage drivers with StorageManager.extend():

import { StorageManager, type Filesystem, type DiskConfig } from '@tyravel/storage';

class S3Disk implements Filesystem {
  constructor(private config: DiskConfig) {}
  async put(path: string, contents: string | Buffer): Promise<void> {
    // upload to S3
  }
  async get(path: string): Promise<Buffer | null> {
    // download from S3
  }
  async exists(path: string): Promise<boolean> {
    // check S3
  }
  async delete(path: string): Promise<boolean> {
    // delete from S3
  }
  url(path: string): string {
    return `https://${this.config.bucket}.s3.amazonaws.com/${path}`;
  }
}

StorageManager.extend('s3', (config) => new S3Disk(config));

Then use it in config/storage.ts:

s3: {
  driver: 's3',
  bucket: 'my-app',
  region: 'us-east-1',
},

Filesystem interface

Every driver implements the Filesystem interface:

interface Filesystem {
  put(path: string, contents: string | Buffer): Promise<void>;
  get(path: string): Promise<Buffer | null>;
  exists(path: string): Promise<boolean>;
  delete(path: string): Promise<boolean>;
  url(path: string): string;
}

Service provider registration

import { StorageServiceProvider } from '@tyravel/core';

app.register(StorageServiceProvider);
await app.boot();

Then wire the facade:

import { setStorageApplication } from '@tyravel/core';

setStorageApplication(app);