Зачем?

У вас могут возникнуть вопросы:

• А для чего вообще создан этот репозиторий?
• Что это за типы такие?
• Зачем мне это все нужно?

Для того, чтобы писать чистый код с меньшим количеством ошибок был создан этот репозиторий с типами для объектов WebSoftHCM.

Этот npm пакет позволяет добавить проверку типов и IntelliSense подсказки в ваши проект (см. пример).

📦 Установка

Важно: типы работают только с typescript<=4.4.4 в связи с тем, что при конкатенации строк + теперь превращается в .concat https://github.com/microsoft/TypeScript/pull/45304

Установка типов сводится к установке самой зависимости в ваш проект и typescript:

npm

npm i [email protected] -D
npm i @umbrik/webtutor-types -D

or yarn

yarn add [email protected] -D
yarn add @umbrik/webtutor-types -D

🔨 Настройка

Типы можно использовать как в проектах, написанных с использованием typescript, так и в проектах, написанных на javascript.

Генерируем конфиг, либо просто создаем вручную файл tsconfig.json

npx tsc -init

Далее обновляем конфиг:

{
  "compilerOptions": {
    "target": "es5",
    "module": "es6",
    "esModuleInterop": true,
    "strict": false,
    "noImplicitAny": true,
    "allowJs": true,
    "isolatedModules": true,
    "moduleResolution": "node",
    "baseUrl": "src",
    "noLib": true,
    "typeRoots": [
      "node_modules/@umbrik/webtutor-types/lib",
      "node_modules/@umbrik/webtutor-types/lib/xml"
    ]
  }
}

⌨️ Пример использования

Примеры использования можно найти в examples