React Hooks
ఈ ప్యాకేజీ ప్రస్తుతం దాని అప్స్ట్రీమ్ ఫోర్క్ నుండి వారసత్వంగా పొందిన లెగసీ నేమింగ్ కన్వెన్షన్లను ఉపయోగిస్తోంది. కోడ్, APIలు మరియు కాన్ఫిగరేషన్లోని "plebbit"కి సంబంధించిన సూచనలు భవిష్యత్ విడుదలలో "bitsocial"కి తరలించబడతాయి. కార్యాచరణ ప్రభావితం కాదు.
bitsocial-react-hooks ప్యాకేజీ Bitsocial ప్రోటోకాల్తో పరస్పర చర్య చేయడానికి సుపరిచితమైన రియాక్ట్ హుక్స్ APIని అందిస్తుంది. ఇది కేంద్ర సర్వర్పై ఆధారపడకుండా ఫీడ్లు, వ్యాఖ్యలు మరియు రచయిత ప్రొఫైల్లను పొందడం, ఖాతాలను నిర్వహించడం, కంటెంట్ను ప్రచురించడం మరియు కమ్యూనిటీలకు సభ్యత్వాన్ని పొందడం వంటి వాటిని నిర్వహిస్తుంది.
ఈ లైబ్రరీ 5chan మరియు ఇతర Bitsocial క్లయింట్ అప్లికేషన్లు ఉపయోగించే ప్రాథమిక ఇంటర్ఫేస్.
bitsocial-react-hooks అనేది AI-సహాయక అభివృద్ధి కోసం నిర్వహించబడే plebbit/plebbit-react-hooks యొక్క తాత్కాలిక ఫోర్క్. ఇది npmకి ప్రచురించబడకుండా GitHub నుండి నేరుగా వినియోగించబడుతుంది.
సంస్థాపన
ప్యాకేజీ ఇంకా npmలో లేనందున, దానిని GitHub నుండి నేరుగా ఇన్స్టాల్ చేయండి, నిర్దిష్ట కమిట్ హాష్కు పిన్ చేయండి:
yarn add https://github.com/bitsocialnet/bitsocial-react-hooks.git#<commit-hash>
<commit-hash>ని మీరు టార్గెట్ చేయాలనుకుంటున్న కమిట్తో భర్తీ చేయండి.
API అవలోకనం
హుక్స్ ఫంక్షనల్ వర్గాలుగా నిర్వహించబడతాయి. ప్రతి వర్గంలో సాధారణంగా ఉపయోగించే హుక్స్ యొక్క సారాంశం క్రింద ఉంది. పూర్తి సంతకాలు, పారామితులు మరియు రిటర్న్ రకాల కోసం, GitHubపై పూర్తి API సూచన.) చూడండి
ఖాతాలు
స్థానిక వినియోగదారు ఖాతాలు, గుర్తింపు మరియు సెట్టింగ్లను నిర్వహించండి.
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?)-- సంఘం నుండి సభ్యత్వం పొందండి లేదా అన్సబ్స్క్రైబ్ చేయండి
రాష్ట్రాలు మరియు RPC
కనెక్షన్ స్థితిని పర్యవేక్షించండి మరియు రిమోట్ Bitsocial డెమోన్తో పరస్పర చర్య చేయండి.
useClientsStates(options?)-- IPFS/పబ్సబ్ క్లయింట్ల కనెక్షన్ స్థితిని అందిస్తుందిusePlebbitRpcSettings()-- ప్రస్తుత RPC డెమోన్ కాన్ఫిగరేషన్ను అందిస్తుంది
అభివృద్ధి
స్థానికంగా హుక్స్ లైబ్రరీలో పని చేయడానికి:
అవసరాలు: Node.js, కోర్ప్యాక్ ప్రారంభించబడింది, నూలు 4
git clone https://github.com/bitsocialnet/bitsocial-react-hooks.git
cd bitsocial-react-hooks
corepack enable
yarn install
పరీక్ష మరియు బిల్డ్ ఆదేశాల కోసం రిపోజిటరీ READMEని చూడండి.
లింకులు
- GitHub: GitHubపై పూర్తి API సూచన
- లైసెన్స్: GPL-2.0-మాత్రమే