मुख्य कंटेंट तक स्किप करें

प्रतिक्रिया हुक

bitsocial-react-hooks पैकेज बिटसोशल प्रोटोकॉल के साथ इंटरैक्ट करने के लिए एक परिचित रिएक्ट हुक एपीआई प्रदान करता है। यह फ़ीड, टिप्पणियाँ और लेखक प्रोफाइल लाने, खातों का प्रबंधन करने, सामग्री प्रकाशित करने और समुदायों की सदस्यता लेने का काम संभालता है - यह सब केंद्रीय सर्वर पर निर्भर हुए बिना।

यह लाइब्रेरी 5चान और अन्य बिटसोशल क्लाइंट अनुप्रयोगों द्वारा उपयोग किया जाने वाला प्राथमिक इंटरफ़ेस है।

नोट

bitsocial-react-hooks को वर्तमान में npm पर प्रकाशित करने के बजाय सीधे GitHub से उपभोग किया जाता है।

इंस्टालेशन​

क्योंकि पैकेज अभी तक npm पर नहीं है, इसे सीधे GitHub से इंस्टॉल करें, एक विशिष्ट कमिट हैश पर पिन करें:

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

<commit-hash> को उस कमिट से बदलें जिसे आप लक्षित करना चाहते हैं।

एपीआई अवलोकन​

हुकों को कार्यात्मक श्रेणियों में व्यवस्थित किया गया है। नीचे प्रत्येक श्रेणी में सबसे अधिक उपयोग किए जाने वाले हुक का सारांश दिया गया है। संपूर्ण हस्ताक्षर, पैरामीटर और रिटर्न प्रकार के लिए, GitHub पर पूर्ण API संदर्भ.) देखें

हिसाब किताब​

स्थानीय उपयोगकर्ता खाते, पहचान और सेटिंग्स प्रबंधित करें।

  • useAccount(accountName?) -- सक्रिय (या नामित) खाता ऑब्जेक्ट लौटाता है
  • useAccounts() -- सभी स्थानीय रूप से संग्रहीत खाते लौटाता है
  • useAccountComments(options?) -- सक्रिय खाते द्वारा प्रकाशित टिप्पणियाँ लौटाता है

टिप्पणियाँ​

व्यक्तिगत टिप्पणियाँ और थ्रेड प्राप्त करें और उनके साथ इंटरैक्ट करें।

  • useComment(commentCid?)--अपनी CID द्वारा एक टिप्पणी प्राप्त करता है
  • useComments(commentCids?) -- बैच में अनेक टिप्पणियाँ लाता है
  • useEditedComment(comment?) -- किसी टिप्पणी का नवीनतम संपादित संस्करण लौटाता है

समुदाय​

समुदाय मेटाडेटा और सेटिंग्स पुनर्प्राप्त करें।

  • एकल-समुदाय लुकअप हुक - पते के आधार पर एक समुदाय लाता है
  • मल्टी-कम्युनिटी लुकअप हुक - कई समुदायों को लाता है
  • सामुदायिक आँकड़े हुक - ग्राहक और पोस्ट की संख्या लौटाता है

लेखक​

लेखक प्रोफाइल और मेटाडेटा देखें।

  • useAuthor(authorAddress?) -- एक लेखक प्रोफ़ाइल लाता है
  • useAuthorComments(options?) -- किसी विशिष्ट लेखक की टिप्पणियाँ लौटाता है
  • useResolvedAuthorAddress(authorAddress?) - एक मानव-पठनीय पते (उदाहरण के लिए, ईएनएस) को उसके प्रोटोकॉल पते पर हल करता है

फ़ीड​

सामग्री फ़ीड की सदस्यता लें और पेजिनेट करें।

  • useFeed(options?) -- एक या अधिक समुदायों से पोस्ट की पृष्ठांकित फ़ीड लौटाता है
  • useBufferedFeeds(feedOptions?) -- तेज रेंडरिंग के लिए एकाधिक फ़ीड को प्री-बफ़र करता है
  • useAuthorFeed(authorAddress?) -- एक विशिष्ट लेखक द्वारा पोस्ट की फ़ीड लौटाता है

कार्रवाई​

सामग्री प्रकाशित करें और लेखन कार्य निष्पादित करें।

  • usePublishComment(options?) -- एक नई टिप्पणी या उत्तर प्रकाशित करें
  • usePublishVote(options?) -- अपवोट या डाउनवोट डालें
  • useSubscribe(options?) -- किसी समुदाय की सदस्यता लें या सदस्यता समाप्त करें

राज्य और आरपीसी​

कनेक्शन स्थिति की निगरानी करें और दूरस्थ बिटसोशल डेमॉन के साथ बातचीत करें।

  • useClientsStates(options?) -- IPFS/pubsub क्लाइंट की कनेक्शन स्थिति लौटाता है
  • आरपीसी सेटिंग्स हुक - वर्तमान आरपीसी डेमॉन कॉन्फ़िगरेशन लौटाता है

विकास​

स्थानीय स्तर पर हुक लाइब्रेरी पर काम करने के लिए:

आवश्यकताएँ: नोड.जेएस, कोरपैक सक्षम, यार्न 4

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

परीक्षण और निर्माण आदेशों के लिए रिपॉजिटरी README का संदर्भ लें।

लिंक​