ప్రధాన కంటెంట్‌కి దాటవేయండి

React హుక్స్

bitsocial-react-hooks ప్యాకేజీ Bitsocial ప్రోటోకాల్‌తో పరస్పర చర్య చేయడానికి సుపరిచితమైన React హుక్స్ APIని అందిస్తుంది. ఫీడ్‌లు, వ్యాఖ్యలు మరియు రచయిత ప్రొఫైల్‌లను తీసుకురావడం, ఖాతాలను నిర్వహించడం, కంటెంట్‌ను ప్రచురించడం, కమ్యూనిటీలకు సబ్‌స్క్రైబ్ చేయడం ఇది చూసుకుంటుంది -- ఇవన్నీ ఏ కేంద్రీయ సర్వర్‌పైనా ఆధారపడకుండానే.

5chan మరియు ఇతర Bitsocial క్లయింట్ అప్లికేషన్‌లు ఉపయోగించే ప్రాథమిక ఇంటర్‌ఫేస్ ఈ లైబ్రరీయే.

గమనించండి

bitsocial-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?) -- ఒక వ్యాఖ్య యొక్క తాజా సవరించిన సంస్కరణను తిరిగి ఇస్తుంది

కమ్యూనిటీలు​

కమ్యూనిటీ మెటాడేటా మరియు సెట్టింగ్‌లను పొందండి.

  • ఒకే కమ్యూనిటీ శోధన హుక్ -- చిరునామా ద్వారా ఒక కమ్యూనిటీని తీసుకువస్తుంది
  • బహుళ కమ్యూనిటీల శోధన హుక్ -- ఒకేసారి అనేక కమ్యూనిటీలను తీసుకువస్తుంది
  • కమ్యూనిటీ గణాంకాల హుక్ -- సబ్‌స్క్రైబర్ మరియు పోస్ట్ సంఖ్యలను తిరిగి ఇస్తుంది

రచయితలు​

రచయిత ప్రొఫైల్‌లు మరియు మెటాడేటాను చూడండి.

  • useAuthor(authorAddress?) -- ఒక రచయిత ప్రొఫైల్‌ను తీసుకువస్తుంది
  • useAuthorComments(options?) -- ఒక నిర్దిష్ట రచయిత రాసిన వ్యాఖ్యలను తిరిగి ఇస్తుంది
  • useResolvedAuthorAddress(authorAddress?) -- మనుషులు చదవగలిగే చిరునామాను (ఉదా., ENS) దాని ప్రోటోకాల్ చిరునామాగా పరిష్కరిస్తుంది

ఫీడ్‌లు​

కంటెంట్ ఫీడ్‌లకు సబ్‌స్క్రైబ్ చేయండి మరియు వాటిని పేజీలవారీగా చూడండి.

  • useFeed(options?) -- ఒకటి లేదా అంతకంటే ఎక్కువ కమ్యూనిటీల పోస్ట్‌లతో కూడిన పేజీలవారీ ఫీడ్‌ను తిరిగి ఇస్తుంది
  • useBufferedFeeds(feedOptions?) -- వేగవంతమైన రెండరింగ్ కోసం బహుళ ఫీడ్‌లను ముందుగానే బఫర్ చేస్తుంది
  • useAuthorFeed(authorAddress?) -- ఒక నిర్దిష్ట రచయిత పోస్ట్‌ల ఫీడ్‌ను తిరిగి ఇస్తుంది

చర్యలు​

కంటెంట్‌ను ప్రచురించండి మరియు రైట్ ఆపరేషన్‌లను నిర్వహించండి.

  • usePublishComment(options?) -- కొత్త వ్యాఖ్యను లేదా ప్రత్యుత్తరాన్ని ప్రచురించండి
  • usePublishVote(options?) -- అప్‌వోట్ లేదా డౌన్‌వోట్ వేయండి
  • useSubscribe(options?) -- ఒక కమ్యూనిటీకి సబ్‌స్క్రైబ్ చేయండి లేదా సబ్‌స్క్రిప్షన్‌ను రద్దు చేయండి

స్థితులు మరియు RPC​

కనెక్షన్ స్థితిని పర్యవేక్షించండి మరియు రిమోట్ Bitsocial డెమోన్‌తో పరస్పర చర్య చేయండి.

  • useClientsStates(options?) -- IPFS/pubsub క్లయింట్‌ల కనెక్షన్ స్థితిని తిరిగి ఇస్తుంది
  • RPC సెట్టింగ్‌ల హుక్ -- ప్రస్తుత 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ని చూడండి.

లింక్‌లు​