Siirry pääsisältöön

Reagoi koukut

bitsocial-react-hooks-paketti tarjoaa tutun React hooks APIn vuorovaikutukseen Bitsocial-protokollan kanssa. Se hoitaa syötteiden, kommenttien ja kirjoittajaprofiilien noudon, tilien hallinnan, sisällön julkaisemisen ja yhteisöjen tilaamisen – kaikki ilman keskuspalvelinta.

Tämä kirjasto on 5chan ja muiden Bitsocial-asiakassovellusten ensisijainen käyttöliittymä.

huomautus

bitsocial-react-hooks kulutetaan tällä hetkellä suoraan GitHubista sen sijaan, että se julkaistaan npm:lle.

Asennus​

Koska paketti ei ole vielä npm:ssä, asenna se suoraan GitHubista kiinnittäen tiettyyn vahvistushajaan:

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

Korvaa <commit-hash> sitoumuksella, johon haluat kohdistaa.

API yleiskatsaus​

Koukut on järjestetty toiminnallisiin luokkiin. Alla on yhteenveto kunkin luokan yleisimmin käytetyistä koukuista. Katso täydelliset allekirjoitukset, parametrit ja palautustyypit täydellinen API-viittaus GitHubissa.

Tilit​

Hallinnoi paikallisia käyttäjätilejä, identiteettiä ja asetuksia.

  • useAccount(accountName?) -- palauttaa aktiivisen (tai nimetyn) tiliobjektin
  • useAccounts() – palauttaa kaikki paikallisesti tallennetut tilit
  • useAccountComments(options?) -- palauttaa aktiivisen tilin julkaisemat kommentit

Kommentit​

Hae ja käytä yksittäisiä kommentteja ja viestiketjuja.

  • useComment(commentCid?) -- hakee yksittäisen kommentin CID-tunnuksellaan
  • useComments(commentCids?) -- hakee useita kommentteja erässä
  • useEditedComment(comment?) -- palauttaa kommentin viimeisimmän muokatun version

yhteisöt​

Hae yhteisön metatiedot ja asetukset.

  • Yhden yhteisön hakukoukku – hakee yhteisön osoitteen perusteella
  • Monen yhteisön hakukoukku – hakee useita yhteisöjä
  • Yhteisön tilastokoukku – palauttaa tilaaja- ja viestimäärät

Tekijät​

Etsi tekijäprofiilit ja metatiedot.

  • useAuthor(authorAddress?) -- hakee tekijäprofiilin
  • useAuthorComments(options?) -- palauttaa tietyn kirjoittajan kommentit
  • useResolvedAuthorAddress(authorAddress?) – ratkaisee ihmisen luettavissa olevan osoitteen (esim. ENS) protokollaosoitteekseen

Syötteet​

Tilaa ja sivuuta sisältösyötteitä.

  • useFeed(options?) – palauttaa sivutetun syötteen yhdestä tai useammasta yhteisöstä
  • useBufferedFeeds(feedOptions?) – esipuskuroi useita syötteitä nopeuttaakseen hahmontamista
  • useAuthorFeed(authorAddress?) -- palauttaa syötteen tietyn kirjoittajan viesteistä

Toiminnot​

Julkaise sisältöä ja suorita kirjoitustoimintoja.

  • usePublishComment(options?) -- julkaise uusi kommentti tai vastaus
  • usePublishVote(options?) -- anna plus- tai miinusäänestys
  • useSubscribe(options?) -- tilaa yhteisö tai peruuta sen tilaus

osavaltiot ja RPC​

Valvo yhteyden tilaa ja ole vuorovaikutuksessa Bitsocial-etädemonin kanssa.

  • useClientsStates(options?) – palauttaa IPFS-/pubsub-asiakkaiden yhteystilan
  • RPC-asetusten koukku – palauttaa nykyisen RPC-daemon-kokoonpanon

Kehitys​

Hooks-kirjaston työskentely paikallisesti:

Edellytykset: Node.js, Corepack käytössä, Lanka 4

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

Katso testi- ja rakennuskomennot arkistosta README.

Linkit​