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? | அதே அடிப்படைச் சேமிப்பகத்தின் உறைகள் பகிரும் ஆப்ஜெக்ட். |