Hub

Доступ только для чтения к каталогу модулей Wippy Hub: получение списка модулей, поиск, запрос метаданных, версий, зависимостей и README.

Загрузка

local hub = require("hub")

Параметры вызова

Каждый вызов принимает необязательную таблицу опций. Ключи, общие для всех вызовов:

Ключ	Тип	Описание
`registry`	string	Переопределение URL реестра
`token`	string	Переопределение API-токена
`timeout`	duration/number	Тайм-аут запроса (например, `"3m"` или секунды)

Вызовы с поддержкой пагинации также принимают page и page_size.

Модули

local result, err = hub.modules.list({
    org = "wippy",
    visibility = "public",
    type = "library",
    sort_order = "downloads_desc",
    page = 1,
    page_size = 20,
})
-- result = { items, total, page, page_size }

Функция	Описание
`hub.modules.list(opts?)`	Список модулей с фильтрами
`hub.modules.search(query, opts?)`	Поиск по строке запроса
`hub.modules.get(module, opts?)`	Получить модуль по `org/name` или по id модуля
`hub.modules.readme(module, opts?)`	Получить README; возвращает `{content, filename, version}`

Опции List/Search

Опция	Значения
`organization_id` / `org`	string
`visibility`	`public`, `private`, `internal`
`type`	`library`, `application`, `agent`, `plugin`
`sort_order`	`name_asc`, `name_desc`, `created_desc`, `updated_desc`, `downloads_desc`
`keywords` (search)	массив строк
`license` (search)	string
`include_deprecated` (search)	boolean

README

local readme, err = hub.modules.readme("wippy/terminal", {
    version = "1.2.3"
})
print(readme.content)

Опция version принимает либо строку версии, либо таблицу вида {id, version, label}.

Версии

local versions, err = hub.versions.list("wippy/http", {
    include_yanked = false,
    page_size = 50,
})

local v, err = hub.versions.get("wippy/http", "1.0.0")

Функция	Описание
`hub.versions.list(module, opts?)`	Список версий модуля
`hub.versions.get(module, version, opts?)`	Получить конкретную версию
`hub.versions.inspect(module, version, opts?)`	Проверить артефакт версии (скачивает и читает бандл)

Зависимости

local deps, err = hub.dependencies.get("wippy/http", "1.0.0")
local users, err = hub.dependents.get("wippy/http")

Функция	Описание
`hub.dependencies.get(module, version?, opts?)`	Зависимости версии модуля
`hub.dependents.get(module, opts?)`	Модули, зависящие от данного

Файлы

local files, err = hub.files.list("wippy/http", "1.0.0")

Функция	Описание
`hub.files.list(module, version, opts?)`	Список файлов версии (`version` обязателен); возвращает `{items, total, page, page_size}`

См. также

CLI Reference — wippy readme, wippy search, wippy publish
Publishing Guide