restate / v1.0.0

API žinynas

Kiekvienas @kkwaenggwari/restate 1.0 eksportas su argumentais, grąžinamomis reikšmėmis ir elgesiu.

Šiame puslapyje

Eksportai

Viskas importuojama iš @kkwaenggwari/restate, žiniatinklyje ir React Native.

Eksportas	Grąžina	Paskirtis
`restate(initial, updater \| options?)`	store hook	Sukurti bendrą store atmintyje.
`persistedRestate(initial, options)`	Išsaugoto store hook	Sukurti store, kuris atkuriamas iš saugyklos ir į ją išsaugomas.
`useRestateScope(factory?)`	factory rezultatas arba scope	Laikyti store komponente; sunaikinami po atjungimo.
`createRestateScope()`	RestateScope	Laikyti store už React ribų; pabaigoje iškvieskite destroy().
`shallow(left, right)`	boolean	Palyginti atrankas vieno lygio gyliu.
`batch(callback)`	callback rezultatas	Pranešti prenumeratoriams vieną kartą po kelių pakeitimų.
`restateManager`	RestateManager	Palaukti paleidimo duomenų ir vykdyti masines operacijas su globaliais store.
`createIndexedDBStorage(options?)`	RestateStorage	Sukurti IndexedDB adapterį su savo duomenų bazės ar store pavadinimu.
`createMMKVStorage(options?)`	RestateStorage	Sukurti MMKV adapterį su savo egzemplioriumi ar konfigūracija.

store yra funkcija, kurią kviečiate kaip hook, su šiais metodais.

Narys	Aprašymas
`useStore()`	Grąžina visą reikšmę ir perpiešiamas po kiekvieno pakeitimo.
`useStore(selector, isEqual?)`	Grąžina atranką; perpiešiamas, kai isEqual (numatytasis Object.is) praneša apie pakeitimą.
`get()`	Dabartinė reikšmė be prenumeratos.
`set(value \| updater)`	Pakeičia reikšmę arba apskaičiuoja ją iš ankstesnės. Po destroy() ignoruojama.
`reset()`	Atkuria aprašytą pradinę reikšmę ir ją grąžina.
`subscribe(listener)`	Po kiekvieno pakeitimo iškviečia listener(value, previous, event); grąžina prenumeratos atšaukimo funkciją.
`subscribeSelector(selector, listener, isEqual?)`	listener iškviečia tik pasikeitus atrankai.
`on(type, listener)`	Klauso įvykių, tokių kaip change, reset, save ar error.
`start() / stop() / isRunning()`	Rankinis updater valdymas.
`destroy() / isDestroyed()`	Atlaisvina listener ir updater. Vėlesnės prenumeratos išmeta STORE_DESTROYED.
`getInitial() / getServerSnapshot() / getError()`	Pradinė reikšmė, serverio momentinė kopija ir paskutinė listener klaida.
`id / kind`	Unikalus id; memory arba persistent.

persistedRestate grąžina store su šiais papildomais nariais.

Narys	Aprašymas
`ready`	Promise, kuris įvykdomas pasibaigus automatiniam įkėlimui, net jei jis nepavyko. Patikrinkite status().
`save()`	Įrašo dabartinę reikšmę; įvykdomas su faktiškai įrašyta reikšme.
`restore()`	Perskaito išsaugotą reikšmę į atmintį.
`hasSaved()`	Ar yra išsaugotas įrašas.
`clearStorage()`	Ištrina išsaugotą įrašą; atmintis nesikeičia.
`resetAndClearStorage()`	Atstato atmintį į pradinę reikšmę ir ištrina išsaugotą įrašą.
`initialize()`	Įkelia dar kartą, pavyzdžiui, ištaisius nepavykusį įrašą.
`status()`	Užšaldyta būsenos momentinė kopija; tas pats objektas, kol pasikeičia kuris nors laukas.
`useStatus(selector?, isEqual?)`	hook, kuris perpiešiamas pasikeitus būsenai ar jos pasirinktai daliai.
`key / storageKey / storage`	Loginis key, key su vardų sritimi ir naudojamas adapteris.

key privalomas. Visos kitos parinktys neprivalomos.

Parinktis	Numatytoji	Reikšmė
`key`	privaloma	Įrašo loginis key.
`namespace`	"@kkwaenggwari/restate"	Išsaugoto key priešdėlis; tuščia eilutė jį išjungia.
`storage`	IndexedDB / MMKV	Adapteris vietoje platformos numatytojo.
`autoSave`	false	true išsaugo po kiekvieno pakeitimo; { delayMs } laukia pauzės.
`version / migrate`	1 / nėra	Įrašo versija ir senesnių įrašų atnaujinimo būdas.
`validate`	nėra	Tikrina reikšmes prieš išsaugojimą ir po atkūrimo ar perkėlimo.
`serializer`	JSON	Savos serialize ir deserialize funkcijos.
`operationTimeoutMs`	30000	Ilgiausia saugyklos operacijos trukmė.
`maxPendingOperations`	256	Leidžiamos laukiančios operacijos, įskaitant vykdomą.
`maxStorageCharacters`	5242880	Didžiausia užkoduota reikšmė UTF-16 kodo vienetais.
`updater / managed / serverSnapshot / onError`	—	Kaip restate parinktys.

status() ir useStatus() grąžina šiuos laukus.

Laukas	Reikšmė
`ready`	Automatinis įkėlimas baigtas.
`dirty`	Atmintis skiriasi nuo paskutinės įkeltos, išsaugotos ar atkurtos reikšmės.
`operation`	Dabartinė saugyklos operacija arba null.
`pending`	Nebaigtos saugyklos operacijos, įskaitant vykdomą.
`blocked`	Atšauktas ar laiko limitą viršijęs adapterio kvietimas dar nesibaigė.
`available`	Ar saugyklą galima naudoti.
`error / observerError`	Paskutinė saugyklos klaida; paskutinė būsenos listener klaida.
`lastSavedAt / lastRestoredAt`	Paskutinės sėkmės epoch milisekundės arba null.

Kiekvienas manager seka jame užregistruotus išsaugotus store.

Narys	Aprašymas
`ready`	Laukia kreipimosi metu užregistruotų store; atmeta su BULK_OPERATION_FAILED.
`saveAll(options?) / restoreAll(options?)`	Vykdo save arba restore kiekvienam store; { concurrency } riboja lygiagretų darbą.
`clearStorageAll() / resetAll() / resetAllAndClearStorage()`	Išvalo įrašus, atstato atmintį arba abu.
`list() / get(idOrKey) / size()`	Užregistruotų store apžiūra.
`subscribe(listener) / status()`	manager įvykių ir listener klaidų stebėjimas.
`destroyAll()`	Sunaikina kiekvieną užregistruotą store.

Kaip storage perduokite objektą su šiais metodais. Kiekvienas metodas gali grąžinti reikšmę arba Promise.

Metodas	Aprašymas
`getItem(key, context?)`	Grąžina išsaugotą eilutę arba null.
`setItem(key, value, context?)`	Išsaugo eilutę.
`removeItem(key, context?)`	Ištrina įrašą.
`isAvailable?()`	Sinchroniškai praneša, ar saugyklą galima naudoti.
`clear?() / close?()`	Neprivalomas išvalymas ir sutvarkymas.
`coordinationKey?`	Tos pačios bazinės saugyklos apvalkalų bendrinamas objektas.

Parašyta restate 1.0 API