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? | అదే అంతర్లీన స్టోరేజ్ యొక్క రాపర్లు పంచుకునే ఆబ్జెక్ట్. |