restate / v1.0.0
API রেফারেন্স
@kkwaenggwari/restate 1.0-এর প্রতিটি এক্সপোর্ট, আর্গুমেন্ট, ফেরত মান আর আচরণ সহ।
এই পাতায়
এক্সপোর্টস্টোরের মেথডসংরক্ষিত স্টোরের মেথডpersistedRestate-এর বিকল্পস্ট্যাটাস ফিল্ডrestateManager আর scope.managerস্টোরেজ অ্যাডাপ্টারের ইন্টারফেসএক্সপোর্ট
সবকিছু @kkwaenggwari/restate থেকে ইমপোর্ট হয়, ওয়েবে আর React Native-এ।
| এক্সপোর্ট | ফেরত দেয় | কীসের জন্য |
|---|---|---|
restate(initial, updater | options?) | স্টোর হুক | মেমরিতে ভাগ করা স্টোর তৈরি করা। |
persistedRestate(initial, options) | সংরক্ষিত স্টোর হুক | এমন স্টোর তৈরি করা যা স্টোরেজ থেকে ফিরে আসে আর সেখানে সংরক্ষিত হয়। |
useRestateScope(factory?) | factory-র ফলাফল বা scope | কম্পোনেন্টে স্টোর রাখা; আনমাউন্টের পরে ধ্বংস হয়। |
createRestateScope() | RestateScope | React-এর বাইরে স্টোর রাখা; শেষে destroy() কল করুন। |
shallow(left, right) | boolean | বাছাইগুলো এক স্তর গভীর পর্যন্ত তুলনা করা। |
batch(callback) | callback-এর ফলাফল | কয়েকটি পরিবর্তনের পরে সাবস্ক্রাইবারদের একবার জানানো। |
restateManager | RestateManager | স্টার্টআপ ডেটার জন্য অপেক্ষা আর গ্লোবাল স্টোরে একসঙ্গে কাজ চালানো। |
createIndexedDBStorage(options?) | RestateStorage | নিজের ডেটাবেস বা স্টোরের নাম দিয়ে IndexedDB অ্যাডাপ্টার তৈরি করা। |
createMMKVStorage(options?) | RestateStorage | নিজের ইনস্ট্যান্স বা কনফিগারেশন দিয়ে MMKV অ্যাডাপ্টার তৈরি করা। |
স্টোরের মেথড
স্টোর একটি ফাংশন যা আপনি হুকের মতো কল করেন, এই মেথডগুলো সহ।
| সদস্য | বিবরণ |
|---|---|
useStore() | পুরো মান ফেরত দেয় এবং প্রতিটি পরিবর্তনে আবার রেন্ডার হয়। |
useStore(selector, isEqual?) | বাছাই ফেরত দেয়; isEqual (ডিফল্ট Object.is) পরিবর্তন জানালে আবার রেন্ডার হয়। |
get() | সাবস্ক্রিপশন ছাড়া বর্তমান মান। |
set(value | updater) | মান প্রতিস্থাপন করে বা আগেরটি থেকে হিসাব করে। destroy()-এর পরে উপেক্ষিত হয়। |
reset() | ঘোষিত প্রাথমিক মান ফিরিয়ে এনে ফেরত দেয়। |
subscribe(listener) | প্রতিটি পরিবর্তনের পরে listener(value, previous, event) কল করে; সাবস্ক্রিপশন বাতিলের ফাংশন ফেরত দেয়। |
subscribeSelector(selector, listener, isEqual?) | বাছাই বদলালে তবেই listener কল করে। |
on(type, listener) | change, reset, save বা error-এর মতো ইভেন্ট শোনে। |
start() / stop() / isRunning() | updater-এর হাতে নিয়ন্ত্রণ। |
destroy() / isDestroyed() | listener আর updater ছেড়ে দেয়। পরের সাবস্ক্রিপশন STORE_DESTROYED ছোঁড়ে। |
getInitial() / getServerSnapshot() / getError() | প্রাথমিক মান, সার্ভার স্ন্যাপশট আর শেষ listener ত্রুটি। |
id / kind | অনন্য id; memory বা persistent। |
সংরক্ষিত স্টোরের মেথড
persistedRestate এই বাড়তি সদস্যসহ একটি স্টোর ফেরত দেয়।
| সদস্য | বিবরণ |
|---|---|
ready | Promise, যা স্বয়ংক্রিয় লোড শেষ হলে পূর্ণ হয়, লোড ব্যর্থ হলেও। status() দেখুন। |
save() | বর্তমান মান লেখে; আসলে লেখা মান দিয়ে পূর্ণ হয়। |
restore() | সংরক্ষিত মান মেমরিতে পড়ে। |
hasSaved() | সংরক্ষিত রেকর্ড আছে কি না। |
clearStorage() | সংরক্ষিত রেকর্ড মোছে; মেমরি বদলায় না। |
resetAndClearStorage() | মেমরি প্রাথমিক মানে রিসেট করে আর সংরক্ষিত রেকর্ড মোছে। |
initialize() | আবার লোড করে, যেমন ব্যর্থ রেকর্ড ঠিক করার পরে। |
status() | অবস্থার জমাট স্ন্যাপশট; কোনো ফিল্ড না বদলানো পর্যন্ত একই অবজেক্ট। |
useStatus(selector?, isEqual?) | হুক, যা স্ট্যাটাস বা তার বাছাই করা অংশ বদলালে আবার রেন্ডার হয়। |
key / storageKey / storage | যৌক্তিক key, নেমস্পেসসহ key আর ব্যবহৃত অ্যাডাপ্টার। |
persistedRestate-এর বিকল্প
key আবশ্যক। বাকি সব বিকল্প ঐচ্ছিক।
| বিকল্প | ডিফল্ট | অর্থ |
|---|---|---|
key | আবশ্যক | রেকর্ডের যৌক্তিক key। |
namespace | "@kkwaenggwari/restate" | সংরক্ষিত key-র উপসর্গ; খালি স্ট্রিং এটি বন্ধ করে। |
storage | IndexedDB / MMKV | প্ল্যাটফর্মের ডিফল্টের বদলে অ্যাডাপ্টার। |
autoSave | false | true প্রতিটি পরিবর্তনের পরে সংরক্ষণ করে; { delayMs } বিরতির জন্য অপেক্ষা করে। |
version / migrate | 1 / নেই | রেকর্ডের সংস্করণ আর পুরোনো রেকর্ড আপগ্রেডের উপায়। |
validate | নেই | সংরক্ষণের আগে আর ফিরিয়ে আনা বা মাইগ্রেশনের পরে মান যাচাই করে। |
serializer | JSON | নিজের serialize আর deserialize ফাংশন। |
operationTimeoutMs | 30000 | স্টোরেজ কাজের সর্বোচ্চ সময়। |
maxPendingOperations | 256 | অনুমোদিত অপেক্ষমাণ কাজ, সক্রিয়টি সহ। |
maxStorageCharacters | 5242880 | UTF-16 কোড ইউনিটে সবচেয়ে বড় এনকোড করা মান। |
updater / managed / serverSnapshot / onError | — | restate-এর বিকল্পের মতো। |
স্ট্যাটাস ফিল্ড
status() আর useStatus() এই ফিল্ডগুলো ফেরত দেয়।
| ফিল্ড | অর্থ |
|---|---|
ready | স্বয়ংক্রিয় লোড শেষ হয়েছে। |
dirty | মেমরি শেষ লোড, সংরক্ষিত বা ফিরিয়ে আনা মান থেকে আলাদা। |
operation | বর্তমান স্টোরেজ কাজ বা null। |
pending | অসমাপ্ত স্টোরেজ কাজ, সক্রিয়টি সহ। |
blocked | বাতিল বা সময় পেরোনো অ্যাডাপ্টার কল এখনো শেষ হয়নি। |
available | স্টোরেজ ব্যবহার করা যায় কি না। |
error / observerError | শেষ স্টোরেজ ত্রুটি; শেষ স্ট্যাটাস listener ত্রুটি। |
lastSavedAt / lastRestoredAt | শেষ সাফল্যের epoch মিলিসেকেন্ড বা null। |
restateManager আর scope.manager
প্রতিটি manager নিজের কাছে নিবন্ধিত সংরক্ষিত স্টোরের খোঁজ রাখে।
| সদস্য | বিবরণ |
|---|---|
ready | অ্যাক্সেসের সময় নিবন্ধিত স্টোরের জন্য অপেক্ষা করে; BULK_OPERATION_FAILED দিয়ে প্রত্যাখ্যান করে। |
saveAll(options?) / restoreAll(options?) | প্রতিটি স্টোরে save বা restore চালায়; { concurrency } সমান্তরাল কাজ সীমিত করে। |
clearStorageAll() / resetAll() / resetAllAndClearStorage() | রেকর্ড পরিষ্কার করে, মেমরি রিসেট করে বা দুটোই। |
list() / get(idOrKey) / size() | নিবন্ধিত স্টোরের পরিদর্শন। |
subscribe(listener) / status() | manager-এর ইভেন্ট আর listener ত্রুটির ওপর নজর। |
destroyAll() | প্রতিটি নিবন্ধিত স্টোর ধ্বংস করে। |
স্টোরেজ অ্যাডাপ্টারের ইন্টারফেস
storage হিসেবে এই মেথডগুলোসহ একটি অবজেক্ট দিন। প্রতিটি মেথড মান বা Promise ফেরত দিতে পারে।
| মেথড | বিবরণ |
|---|---|
getItem(key, context?) | সংরক্ষিত স্ট্রিং বা null ফেরত দেয়। |
setItem(key, value, context?) | স্ট্রিং সংরক্ষণ করে। |
removeItem(key, context?) | রেকর্ড মোছে। |
isAvailable?() | স্টোরেজ ব্যবহার করা যায় কি না তা সিঙ্ক্রোনাসভাবে জানায়। |
clear?() / close?() | ঐচ্ছিক ফ্লাশ আর পরিষ্কারকরণ। |
coordinationKey? | একই মূল স্টোরেজের র্যাপারগুলোর ভাগ করা অবজেক্ট। |