restate / v1.0.0
API संदर्भ
@kkwaenggwari/restate 1.0 चे प्रत्येक export, आर्ग्युमेंट, परत मूल्ये आणि वर्तनासह.
या पानावर
Exportस्टोअर मेथडसेव्ह होणाऱ्या स्टोअरच्या मेथडpersistedRestate पर्यायस्थिती फील्ड्सrestateManager आणि scope.managerस्टोरेज अडॅप्टर इंटरफेसExport
सर्व @kkwaenggwari/restate मधून import केले जातात — वेबवर आणि React Native वर.
| Export | काय परत करते | कशासाठी |
|---|---|---|
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 | तुमच्या स्वतःच्या डेटाबेस किंवा store नावासह 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?() | स्टोरेज वापरता येते का ते synchronous पद्धतीने कळवते. |
clear?() / close?() | ऐच्छिक flush आणि स्वच्छता. |
coordinationKey? | त्याच मूळ स्टोरेजच्या रॅपरनी सामायिक केलेला ऑब्जेक्ट. |