Deepkit Filesystem

npm install @deepkit/filesystem

import { Filesystem, FilesystemLocalAdapter } from '@deepkit/filesystem';

const adapter = new FilesystemLocalAdapter('/path/to/my/files');
const filesystem = new Filesystem(adapter);

const files = await filesystem.files();
for (const file of files) {
    console.log(file.path);
}

await filesystem.write('myFile.txt', 'Hello World');
const file = await filesystem.get('myFile.txt');
console.log(file.path, file.size, file.lastModified);

const content = await filesystem.read('myFile.txt');

const files = await filesystem.files();
for (const file of files) {
    console.log(file.path);
}

const files = await filesystem.allFiles();
for (const file of files) {
    console.log(file.path);
}

const content = await filesystem.read('myFile.txt');

const content = await filesystem.readAsText('myFile.txt');

await filesystem.write('myFile.txt', 'Hello World');

const path = await filesystem.writeFile('/', { path: '/path/to/local/file.txt' });

// UploadedFile 과 함께 동작합니다
router.post('/upload', async (body: HttpBody<{ file: UploadedFile }>, filesystem: Filesystem, session: Session) => {
    const user = session.getUser();
    const path = await filesystem.writeFile('/user-images', body.file, { name: `user-${user.id}` });
    //path = /user-images/user-123.jpg
});

await filesystem.delete('myFile.txt');

await filesystem.deleteDirectory('myFolder');

await filesystem.makeDirectory('myFolder');

await filesystem.move('myFile.txt', 'myFolder/myFile.txt');

await filesystem.copy('myFile.txt', 'myFolder/myFile.txt');

const file: FilesystemFile = await filesystem.get('myFile.txt');
console.log(file.path, file.size, file.lastModified);

interface FilesystemFile {
    path: string;
    type: FileType; //파일 또는 디렉터리
    size: number;
    lastModified?: Date;
    /**
     * 파일의 visibility.
     *
     * 일부 adapter는 파일의 visibility 읽기를 지원하지 않을 수 있습니다.
     * 이 경우 visibility는 항상 'private'입니다.
     *
     * 일부 adapter는 파일 나열 시에는 visibility를 지원하지 않지만, 개별 파일 조회에서는 지원할 수 있습니다.
     * 이 경우 visibility를 로드하려면 추가로 `filesystem.get(file)` 을 호출해야 합니다.
     */
    visibility: FileVisibility; //public 또는 private
    constructor(path: string, type?: FileType);
    /**
     * 이 파일이 심볼릭 링크인 경우 true를 반환합니다.
     */
    isFile(): boolean;
    /**
     * 이 파일이 디렉터리인 경우 true를 반환합니다.
     */
    isDirectory(): boolean;
    /**
     * 파일의 이름(basename)을 반환합니다.
     */
    get name(): string;
    /**
     * 이 파일이 주어진 디렉터리에 있는 경우 true를 반환합니다.
     */
    inDirectory(directory: string): boolean;
    /**
     * 파일의 디렉터리(dirname)를 반환합니다.
     */
    get directory(): string;
    /**
     * 파일의 확장자를 반환합니다. 존재하지 않거나 디렉터리인 경우 빈 문자열을 반환합니다.
     */
    get extension(): string;
}

if (await filesystem.exists('myFile.txt')) {
    console.log('File exists');
}

await filesystem.setVisibility('myFile.txt', 'public');
await filesystem.write('myFile.txt', 'Hello World', 'public');

const visibility = await filesystem.getVisibility('myFile.txt');
const file = await filesystem.get('myFile.txt');
console.log(file.visibility);

const url = filesystem.publicUrl('myFile.txt');

const filesystem = new Filesystem(new FilesystemLocalAdapter('/path/to/my/files'), {
    baseUrl: 'https://my-domain.com/assets/'
});

const url = await filesystem.publicUrl('myFile.txt');
console.log(url); //https://my-domain.com/assets/myFile.txt

const filesystem = new Filesystem(new FilesystemLocalAdapter('/path/to/my/files'), {
    visibility: 'private', //파일의 기본 visibility
    directoryVisibility: 'private', //디렉터리의 기본 visibility
    pathNormalizer: (path: string) => path, //path를 정규화합니다. 기본적으로 `[^a-zA-Z0-9\.\-\_]` 를 `-` 로 대체합니다.
    urlBuilder: (path: string) => path, //파일의 public URL을 생성합니다. 기본적으로 baseUrl + path를 반환합니다
    baseUrl: '', //public URL을 위한 base URL
});