Перейти к основному содержанию

React Hooks

Устаревшее именование

В настоящее время этот пакет использует устаревшие соглашения об именах, унаследованные от его исходной ветки. Ссылки на «plebbit» в коде, API и конфигурации будут перенесены в «bitsocial» в будущем выпуске. Функциональность не нарушена.

Пакет bitsocial-react-hooks предоставляет знакомый API перехватчиков React для взаимодействия с протоколом Bitsocial. Он обрабатывает получение каналов, комментариев и профилей авторов, управляет учетными записями, публикует контент и подписывается на сообщества — и все это без использования центрального сервера.

Эта библиотека является основным интерфейсом, используемым 5chan и другими клиентскими приложениями Bitsocial.

примечание

bitsocial-react-hooks — это временная версия plebbit/plebbit-react-hooks, предназначенная для разработки с помощью искусственного интеллекта. Он потребляется непосредственно из GitHub, а не публикуется в npm.

Установка​

Поскольку пакета еще нет в npm, установите его непосредственно с GitHub, привязав к определенному хэшу коммита:

yarn add https://github.com/bitsocialnet/bitsocial-react-hooks.git#<commit-hash>

Замените <commit-hash> на коммит, который вы хотите использовать.

Обзор API​

Крючки организованы по функциональным категориям. Ниже приводится краткое описание наиболее часто используемых крючков в каждой категории. Полные подписи, параметры и типы возвращаемых значений см. в полный справочник по API на GitHub.

Счета​

Управляйте локальными учетными записями пользователей, удостоверениями и настройками.

  • useAccount(accountName?) — возвращает активный (или именованный) объект учетной записи.
  • useAccounts() — возвращает все локально сохраненные учетные записи.
  • useAccountComments(options?) — возвращает комментарии, опубликованные активной учетной записью.

Комментарии​

Получайте отдельные комментарии и темы и взаимодействуйте с ними.

  • useComment(commentCid?) — извлекает один комментарий по его CID.
  • useComments(commentCids?) — пакетно извлекает несколько комментариев.
  • useEditedComment(comment?) — возвращает последнюю отредактированную версию комментария.

Сообщества​

Получить метаданные и настройки сообщества.

  • useSubplebbit(subplebbitAddress?) — извлекает сообщество по адресу.
  • useSubplebbits(subplebbitAddresses?) — извлекает несколько сообществ.
  • useSubplebbitStats(subplebbitAddress?) — возвращает количество подписчиков и сообщений.

Авторы​

Найдите профили авторов и метаданные.

  • useAuthor(authorAddress?) — извлекает профиль автора.
  • useAuthorComments(options?) — возвращает комментарии конкретного автора.
  • useResolvedAuthorAddress(authorAddress?) — преобразует удобочитаемый адрес (например, ENS) в его адрес протокола.

Ленты​

Подпишитесь на каналы контента и разбивайте их на страницы.

  • useFeed(options?) — возвращает постраничный канал сообщений из одного или нескольких сообществ.
  • useBufferedFeeds(feedOptions?) — предварительно буферизует несколько каналов для более быстрого рендеринга.
  • useAuthorFeed(authorAddress?) — возвращает ленту сообщений определенного автора.

Действия​

Публикуйте контент и выполняйте операции записи.

  • usePublishComment(options?) — опубликовать новый комментарий или ответ
  • usePublishVote(options?) — проголосовать за или против
  • useSubscribe(options?) -- подписаться на сообщество или отписаться от него.

Штаты и РПК​

Отслеживайте состояние соединения и взаимодействуйте с удаленным демоном Bitsocial.

  • useClientsStates(options?) — возвращает состояние подключения клиентов IPFS/pubsub.
  • usePlebbitRpcSettings() — возвращает текущую конфигурацию демона RPC.

Разработка​

Чтобы работать с библиотекой перехватчиков локально:

Предварительные требования: Node.js, Corepack включен, Yarn 4.

git clone https://github.com/bitsocialnet/bitsocial-react-hooks.git
cd bitsocial-react-hooks
corepack enable
yarn install

Обратитесь к README репозитория для команд тестирования и сборки.

Ссылки​