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? | ಅದೇ ಆಧಾರ ಸ್ಟೋರೇಜ್‌ನ ಹೊದಿಕೆಗಳು ಹಂಚಿಕೊಳ್ಳುವ ಆಬ್ಜೆಕ್ಟ್. |