Начало работы
Установка
Установите пакет, используя менеджер пакетов NPM:
bash
npm i kodzero-sdkБыстрый старт
Перед началом работы с SDK необходимо создать его экземпляр и настроить подключение к вашему проекте (или публичному проекту).
Создание экземпляра
js
import Kodzero from 'kodzero-sdk'
const kodzero = new Kodzero({
host: 'https://api.kodzero.pro/:project',
authCollection: 'auth' // optional
})Параметры конфигурации
| Параметр | Тип | Обязательный | Описание |
|---|---|---|---|
| host | string | ✅ | Базовый URL Kodzero проекта |
| authCollection | string | ✅ | Название коллекции, используемой для аутентификации |
authCollection
Название коллекции в базе данных, которая хранит данные пользователей и используется для аутентификации:
js
authCollection: '10099'
authCollection: '10101'Структура экземпляра Kodzero
После инициализации экземпляр Kodzero содержит:
| Свойство | Описание |
|---|---|
tokensManager | Управление токенами доступа (автоматически используется SDK) |
authCollection | Название коллекции для аутентификации (ваше значение) |
host | Базовый URL вашего Kodzero-проекта |
api | Внутренний HTTP-клиент для работы с API |
auth | Модуль для аутентификации и работы с пользователем |
createModel | Метод для создания моделей коллекций (работа с данными) |