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

توابع کمکی سرویس‌ها (server.ts)

توابع کمکی مربوط به مدیریت سرور، لاگ‌گیری و تنظیمات سیستم.

config​

دریافت تنظیمات سرور.

function config<T = string, S extends KimiaSettings = KimiaSettings>(
  key: keyof S,
  def: T = undefined
): T

پارامترها:

  • key: کلید تنظیمات
  • def: مقدار پیش‌فرض

بازگشتی: مقدار تنظیمات

envVar​

دریافت متغیرهای محیطی.

function envVar<T = string>(key: string, def: T = undefined): T

loadSettings​

بارگذاری تنظیمات بر اساس محیط.

async function loadSettings(mode: ServerMode): Promise<KimiaSettings>

loadJsonSettings​

بارگذاری تنظیمات از فایل JSON.

function loadJsonSettings(path: string): boolean

mkdirRequired​

ایجاد دایرکتوری‌های مورد نیاز.

function mkdirRequired(): void

infoLog​

لاگ‌گیری اطلاعات.

function infoLog(
  name: string,
  message: string,
  justOnConsole?: boolean
): void

debugLog​

لاگ‌گیری اطلاعات debug.

function debugLog(name: string, message: string, justOnConsole = true): void

errorLog​

لاگ‌گیری خطا.

function errorLog(
  name: string,
  error: any,
  options?: { uid?: string | number; justShowOnConsole?: boolean }
): void

dbLog​

لاگ‌گیری در دیتابیس.

async function dbLog(
  namespace: string,
  name: string,
  text: any,
  mode: LogMode = LogMode.ERROR,
  options?: { uid?: number; ip?: string }
): Promise<void>

fallbackServer​

اجرای سرور fallback.

async function fallbackServer(): Promise<boolean>

restartServer​

راه‌اندازی مجدد سرور.

async function restartServer(): Promise<boolean>

shutdownServer​

خاموش کردن سرور (single-thread).

async function shutdownServer(): Promise<void>

shutdownClusterServer​

خاموش کردن سرور cluster.

async function shutdownClusterServer(): Promise<boolean>

getAppAbsolutePath​

دریافت مسیر مطلق برنامه.

function getAppAbsolutePath(appName?: string): string

getFSApps​

دریافت لیست برنامه‌های موجود در فایل سیستم.

async function getFSApps(): Promise<string[]>

loadAllAppsIntoDB​

بارگذاری همه برنامه‌ها در دیتابیس.

async function loadAllAppsIntoDB(commonGroupId?: number): Promise<CoreAppModel[]>

getRootAccessUser​

دریافت کاربر با دسترسی root.

async function getRootAccessUser(): Promise<CoreUserModel>

installServer​

نصب اولیه سرور.

async function installServer(): Promise<boolean>

getRequestCustomField​

دریافت فیلد سفارشی درخواست.

function getRequestCustomField<T = any>(
  field: RequestCustomField,
  req: Request
): T

setRequestCustomField​

تنظیم فیلد سفارشی درخواست.

function setRequestCustomField<T = any>(
  field: RequestCustomField,
  req: Request,
  value: T
): void

commandExecute​

اجرای دستور سیستم.

async function commandExecute(
  command: string | string[],
  cwd?: string
): Promise<ExecResponse>

loadAppEnabledModules​

بارگذاری ماژول‌های فعال برنامه.

async function loadAppEnabledModules(appName: string, force = false): Promise<string[]>

importDynamicModule​

ایمпорт پویا ماژول.

async function importDynamicModule<T = any>(
  name: string,
  fallback?: T
): Promise<T>

checkServerStatus​

بررسی وضعیت سرور و لایسنس.

async function checkServerStatus(): Promise<boolean>

getHttpStatusString​

تبدیل کد وضعیت HTTP به رشته.

function getHttpStatusString(statusCode: number): string