Ugrás a fő tartalomhoz

React Hooks

A bitsocial-react-hooks csomag egy ismerős React hooks API-t biztosít a Bitsocial protokollal való interakcióhoz. Kezeli a hírfolyamok, megjegyzések és szerzői profilok lekérését, a fiókok kezelését, a tartalom közzétételét és a közösségekre való feliratkozást – mindezt anélkül, hogy központi szerverre támaszkodna.

Ez a könyvtár az 5chan és más Bitsocial ügyfélalkalmazások által használt elsődleges felület.

megjegyzés

A bitsocial-react-hooks-t jelenleg közvetlenül a GitHubról fogyasztják, nem pedig npm-ben teszik közzé.

Telepítés​

Mivel a csomag még nincs npm-en, telepítse közvetlenül a GitHubról, rögzítve egy adott véglegesítési hashhez:

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

Cserélje le a <commit-hash> értéket a megcélozni kívánt véglegesítésre.

API áttekintése​

A horgok funkcionális kategóriákba vannak rendezve. Az alábbiakban összefoglaljuk az egyes kategóriákban leggyakrabban használt horgokat. A teljes aláírások, paraméterek és visszatérési típusok megtekintéséhez lásd a teljes API-referencia a GitHubon.

Fiókok​

Helyi felhasználói fiókok, identitások és beállítások kezelése.

  • useAccount(accountName?) -- az aktív (vagy elnevezett) fiókobjektumot adja vissza
  • useAccounts() -- visszaadja az összes helyileg tárolt fiókot
  • useAccountComments(options?) -- az aktív fiók által közzétett megjegyzéseket adja vissza

Megjegyzések​

Egyéni megjegyzések és szálak lekérése és interakciója.

  • useComment(commentCid?) -- egyetlen megjegyzést kér le a CID alapján
  • useComments(commentCids?) -- több megjegyzést tölt le kötegben
  • useEditedComment(comment?) -- a megjegyzés legutóbbi szerkesztett verzióját adja vissza

közösségek​

Közösségi metaadatok és beállítások lekérése.

  • Egyközösségi keresési horog -- cím alapján kéri le a közösséget
  • Többközösségi keresési horog -- több közösséget tölt le
  • Közösségi statisztikai horog -- visszaadja a feliratkozók és bejegyzések számát

Szerzők​

Keresse meg a szerzői profilokat és a metaadatokat.

  • useAuthor(authorAddress?) -- szerzői profilt kér le
  • useAuthorComments(options?) -- egy adott szerző megjegyzéseit adja vissza
  • useResolvedAuthorAddress(authorAddress?) -- az ember által olvasható címet (pl. ENS) a protokollcímére oldja fel

Feedek​

Iratkozzon fel a tartalmi hírcsatornákra és lapozzon.

  • useFeed(options?) -- egy vagy több közösség bejegyzéseinek lapszámozott hírfolyamát adja vissza
  • useBufferedFeeds(feedOptions?) – több feedet előpufferel a gyorsabb megjelenítés érdekében
  • useAuthorFeed(authorAddress?) -- egy adott szerző bejegyzéseinek feedjét adja vissza

Akciók​

Tartalom közzététele és írási műveletek végrehajtása.

  • usePublishComment(options?) -- új megjegyzés vagy válasz közzététele
  • usePublishVote(options?) -- pozitív vagy negatív szavazat leadása
  • useSubscribe(options?) -- feliratkozás egy közösségre, vagy leiratkozás egy közösségről

államok és az RPC​

Figyelje a kapcsolat állapotát, és lépjen kapcsolatba egy távoli Bitsocial démonnal.

  • useClientsStates(options?) -- visszaadja az IPFS/pubsub ügyfelek kapcsolati állapotát
  • RPC beállítások hook -- az aktuális RPC démon konfigurációt adja vissza

Fejlesztés​

Ha helyileg szeretne dolgozni a hooks könyvtáron:

Előfeltételek: Node.js, Corepack engedélyezve, Fonal 4

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

Teszt és build parancsokat a README lerakatban talál.

Linkek​