Auxx Documentation

The storage API provides a simple key-value store scoped to your app. Import from @auxx/sdk/server.

get

Read a value by key. Returns null if the key doesn't exist.

src/my-action.server.ts

import { get } from '@auxx/sdk/server'

const lastSync = await get('lastSyncTimestamp')

set

Write a value. Overwrites any existing value for that key.

src/my-action.server.ts

import { set } from '@auxx/sdk/server'

await set('lastSyncTimestamp', new Date().toISOString())

remove

Delete a key-value pair.

src/my-action.server.ts

import { remove } from '@auxx/sdk/server'

await remove('lastSyncTimestamp')

Summary

Function	Signature	Description
`get`	`(key: string) => Promise<string \| null>`	Read a value
`set`	`(key: string, value: string) => Promise<void>`	Write a value
`remove`	`(key: string) => Promise<void>`	Delete a value

Values are stored as strings. Serialize objects with JSON.stringify() and parse them with JSON.parse().

Example: storing JSON

src/sync.server.ts

import { get, set } from '@auxx/sdk/server'

interface SyncState {
  cursor: string
  lastSyncAt: string
}

async function getSyncState(): Promise<SyncState | null> {
  const raw = await get('syncState')
  return raw ? JSON.parse(raw) : null
}

async function saveSyncState(state: SyncState): Promise<void> {
  await set('syncState', JSON.stringify(state))
}

Storage

get

set

remove

Summary

Example: storing JSON

On this page