Interface: PendingSwapStoreOptions

gSwap SDK 2.0.0-rc.4

---

gSwap SDK 2.0.0-rc.4 / PendingSwapStoreOptions

Interface: PendingSwapStoreOptions

Defined in: packages/gswap-sdk/dist/index.d.ts:3710

Options for PendingSwapStore.

Properties

darkFlagField?

optional darkFlagField?: "isDarkSwap" | "shadow"

Defined in: packages/gswap-sdk/dist/index.d.ts:3723

The stored name of the dark-swap flag: isDarkSwap (default) or shadow, for storage written by an older web app. Entries are always exposed to callers as isDarkSwap.

---

insertAt?

optional insertAt?: "end" | "start"

Defined in: packages/gswap-sdk/dist/index.d.ts:3727

Where remember puts a new entry in the stored array: end (default) or start.

---

listOrder?

optional listOrder?: "stored" | "newest-first"

Defined in: packages/gswap-sdk/dist/index.d.ts:3732

The order of list: stored (default: oldest first for insertAt: 'end') or newest-first.

---

now?

optional now?: () => number

Defined in: packages/gswap-sdk/dist/index.d.ts:3734

Clock, in epoch milliseconds. Defaults to Date.now.

Returns

number

---

onPrune?

optional onPrune?: (pruned) => void

Defined in: packages/gswap-sdk/dist/index.d.ts:3716

Called once per dropped entry (after the drop is persisted, for list; at once for a remember that refuses an invalid key), so the app can tell the user or log why a swap it was tracking is gone. Diagnostics only: what it does, or throws, never changes the store.

Parameters

pruned

PrunedPendingSwap

Returns

void

---

storageKey?

optional storageKey?: string

Defined in: packages/gswap-sdk/dist/index.d.ts:3718

Storage key. Default PENDING_SWAPS_STORAGE_KEY.