پرش به مطلب اصلی

توابع کمکی سیستم فایل (file-system.ts)

توابع کمکی مربوط به کار با فایل‌ها و دایرکتوری‌ها.

copyDirectory​

کپی کردن دایرکتوری به همراه محتویات آن.

async function copyDirectory(
  path: string,
  newPath: string,
  excludeFiles?: string[],
  excludeDirs?: string[]
): Promise<boolean>

پارامترها:

  • path: مسیر مبدأ
  • newPath: مسیر مقصد
  • excludeFiles: فایل‌هایی که کپی نشوند
  • excludeDirs: دایرکتوری‌هایی که کپی نشوند

بازگشتی: true در صورت موفقیت

getFileMimeType​

دریافت نوع MIME فایل.

async function getFileMimeType(path: string): Promise<string>

پارامترها:

  • path: مسیر فایل

بازگشتی: نوع MIME فایل یا undefined

نکته: از پکیج‌های file-type، mmmagic یا mime-types استفاده می‌کند.

removeEntries​

حذف فایل‌ها یا دایرکتوری‌ها بر اساس الگو.

async function removeEntries(
  basePath: string,
  entries: string[]
): Promise<boolean>

پارامترها:

  • basePath: مسیر پایه
  • entries: لیست فایل‌ها یا الگوها برای حذف

بازگشتی: true در صورت موفقیت

getFilesList​

دریافت لیست فایل‌ها در یک دایرکتوری.

function getFilesList(
  path: string,
  match?: RegExp,
  maxLevel = -1,
  options?: { excludeDirectories?: string[] }
): FileInfo[]

پارامترها:

  • path: مسیر دایرکتوری
  • match: عبارت منظم برای فیلتر فایل‌ها
  • maxLevel: حداکثر سطح recurs (پیش‌فرض: unlimited)
  • options.excludeDirectories: دایرکتوری‌هایی که جستجو نشوند

بازگشتی: آرایه‌ای از اشیاء FileInfo

createZipFile​

ایجاد فایل ZIP از یک دایرکتوری.

async function createZipFile(
  dirPath: string,
  newPath: string,
  excludeFiles?: string[],
  excludeDirs?: string[]
): Promise<string | undefined>

پارامترها:

  • dirPath: مسیر دایرکتوری مبدأ
  • newPath: مسیر فایل ZIP خروجی
  • excludeFiles: فایل‌هایی که در ZIP قرار نگیرند
  • excludeDirs: دایرکتوری‌هایی که در ZIP قرار نگیرند

بازگشتی: مسیر فایل ZIP ایجاد شده

extractZipFile​

استخراج فایل ZIP.

async function extractZipFile(
  filePath: string,
  extractPath: string
): Promise<boolean>

پارامترها:

  • filePath: مسیر فایل ZIP
  • extractPath: مسیر استخراج

بازگشتی: true در صورت موفقیت