@vielzeug/sourcerer

Reactive collection sources with local, page, cursor, and infinite pagination

Installation

pnpm add @vielzeug/sourcerer
npm install @vielzeug/sourcerer
yarn add @vielzeug/sourcerer

Quick Start

import { createPageSource } from '@vielzeug/sourcerer';

const users = createPageSource({
  load: async ({ page, pageSize }) => ({
    items: [{ id: page, name: 'Ada' }].slice(0, pageSize),
    totalItems: 1,
  }),
  pageSize: 20,
});

try {
  await users.apply({ page: 1 });
  console.log(users.state.items);
  console.log(users.state.pagination.totalItems);
} catch (error) {
  console.error(error);
} finally {
  users.dispose();
}

Features

• PageSource.apply(): reconcile page and structurally compared parameters in at most one request.
• createResource(): load one observable value immediately, or pass start: false and await reload(); failures retain previous data.

Documentation

• Overview
• Usage Guide
• API Reference
• Examples
• Migration Guide

License

MIT © Helmuth Saatkamp: part of the Vielzeug monorepo.