प्रतिक्रिया हुक
Bitsocial प्रोटोकॉलशी संवाद साधण्यासाठी bitsocial-react-hooks पॅकेज एक परिचित प्रतिक्रिया हुक API प्रदान करते. हे फीड, टिप्पण्या आणि लेखक प्रोफाइल आणणे, खाती व्यवस्थापित करणे, सामग्री प्रकाशित करणे आणि समुदायांची सदस्यता घेणे - सर्व काही केंद्रीय सर्व्हरवर अवलंबून न राहता हाताळते.
ही लायब्ररी 5chan आणि इतर बिटसोशियल क्लायंट ऍप्लिकेशन्सद्वारे वापरली जाणारी प्राथमिक इंटरफेस आहे.
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
कनेक्शन स्थितीचे निरीक्षण करा आणि रिमोट बिटसोशियल डिमनसह संवाद साधा.
useClientsStates(options?)-- आयपीएफएस/पबसब क्लायंटची कनेक्शन स्थिती परत करते- RPC सेटिंग्ज हुक -- वर्तमान RPC डिमन कॉन्फिगरेशन परत करते
विकास
हुक लायब्ररीवर स्थानिक पातळीवर काम करण्यासाठी:
पूर्वआवश्यकता: Node.js, Corepack सक्षम, सूत ४
git clone https://github.com/bitsocialnet/bitsocial-react-hooks.git
cd bitsocial-react-hooks
corepack enable
yarn install
चाचणी आणि बिल्ड कमांडसाठी रेपॉजिटरी README चा संदर्भ घ्या.
दुवे
- GitHub: bitsocialnet/bitsocial-react-hooks
- परवाना: GPL-2.0-केवळ