[v2.x] feat: allow adding type to router.restore

[peaklabs-dev]

Changes

• feat: allow adding type to state restore

Example

I want to use the state to restore form values which need to be typed for my forms to work properly (I use TanStack form).

type FormState = {
  username: string
  notifications_enabled: boolean
}

const FORM_STATE_KEY = 'TEST'
const restoredState = router.restore<FormState>(FORM_STATE_KEY)

[pascalbaljet]

Where does 'TEST' come from in this context? I would expect it to behave like this (open for discussion, though!):

type RememberedState = {
  name: string
  isAdmin: boolean
}

const key = 'isAdmin'

router.restore('id') // no generic, should always work
router.restore<RememberedState>('name') // should be string | undefined
router.restore<RememberedState>('email') // ts-expect-error, email doesn't exist on RememberedState
router.restore<RememberedState>(key) // should be boolean | undefined

[peaklabs-dev]

@pascalbaljet Oh, the FORM_STATE_KEY is just the key for where the data is stored, nothing more. I remember the form data via a listener like this:

        listeners: {
            onChange: ({ formApi }) => {
                router.remember(formApi.state.values, FORM_STATE_KEY);
            },
        },