Публичное API

Публичное API

Публичное API — это то, ради чего библиотека выпускается: оно описано в документации и меняется по правилам совместимости. Пометка @deprecated со сроком удаления, переходный период, строка в чейнжлоге — обязательства платформы касаются только его.

Остальное, что физически лежит в пакете, — платформенная кухня. Она нужна оболочке Q.Palette и самим библиотекам, а продукту не адресована.

Что можно использовать

Всё, что импортируется из основного пути пакета@diasoft/qpalette-auth, @diasoft/qpalette-core, @diasoft/qpalette-visual и так далее — и описано в документации.

Что использовать нельзя

  • Имена, начинающиеся с ɵ. Приставка стоит именно затем, чтобы такой член нельзя было принять за публичный.
  • Импорт не из основного пути пакета — подпути вида @diasoft/qpalette-auth/… существуют для оболочки.
  • Всё, что не описано в документации, даже если редактор предлагает это в автодополнении: подсказка показывает содержимое пакета, а не контракт платформы.
⚠️

У этих членов нет обязательств совместимости. Они меняются и исчезают в любом выпуске, включая исправляющий, — без пометки @deprecated, без переходного периода и без строки в чейнжлоге. Продукт, который на них опирается, ломается при очередном обновлении Q.Palette, и хорошо, если на сборке, а не у пользователя.

Если нужного нет в публичном API

Напишите нам — см. Техническая поддержка. Нехватка возможности это повод добавить её в публичное API и описать, а не импортировать внутреннее: добавленное мы поддерживаем, импортированное в обход — нет.