مرکزی مواد پر جائیں۔

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 دیکھیں۔

لنکس​