schema.Invalidate

Describes entities to be marked as INVALID. This removes items from a collection, or forces suspense for endpoints where the entity is required.

Constructor:

• entity which entity to invalidate. The input is used to compute the pk() for lookup.

Usage

Fixtures

GET /users

[{"id":"123","name":"Jim"},{"id":"456","name":"Jane"},{"id":"555","name":"Phone"}]

▶api/User.ts

const sampleDelete = ({ id }) => Promise.resolve({ id });

class User extends Entity {
  id = '';
  name = '';
  pk() {
    return this.id;
  }
}
const userList = new RestEndpoint({
  path: '/users',
  schema: [User],
});
const userDelete = new Endpoint(sampleDelete, {
  schema: new schema.Invalidate(User),
});

▶UserPage.tsx

function UsersPage() {
  const users = useSuspense(userList);
  const ctrl = useController();
  return (
    <div>
      {users.map(user => (
        <div key={user.pk()}>
          {user.name}{' '}
          <span
            style={{ cursor: 'pointer' }}
            onClick={() => ctrl.fetch(userDelete, { id: user.id })}
          >
            ❌
          </span>
        </div>
      ))}
    </div>
  );
}
render(<UsersPage />);

Live Preview

Loading...

Store▶

• • entities:{} 0 keys
  • indexes:{} 0 keys
  • results:{} 0 keys
  • meta:{} 0 keys
  • entityMeta:{} 0 keys
  • lastReset:0

Batch Invalidation

Here we add another endpoint for deleting many entities at a time. Here we pass in a list of ids, and the response is an empty string.

Constructing an article response using the params argument in fetch empowers the normalized cache to know which entities to invalidate when the request is success, or if optimistic updates are used.

import { Resource, schema } from '@rest-hooks/rest';

class MyResource extends Resource {
  static deleteList<T extends typeof MyResource>(this: T) {
    const init = this.getFetchInit({ method: 'DELETE' });
    return new Endpoint(
      (params: readonly string[]) =>
        this.fetch(this.url(params).then(() => params.map(id => ({ id })))),
      {
        ...this.getEndpointExtra(),
        schema: [new schemas.Invalidate(this)],
      },
    );
  }
}

function MyTable() {
  const { selectedIds } = useFields(TableForm);
  const list = useSuspense(MyResource.list());
  const ctrl = useController();

  return (
    <div>
      <header>
        <span>My Table</span>
        <button onClick={() => ctrl.fetch(MyResource.delete, selectedIds)}>
          Delete
        </button>
      </header>
      <TableBody data={list} form={TableForm} />
    </div>
  );
}

Impact on useSuspense()

When entities are invalidated in a result currently being presented in React, useSuspense() will consider them invalid

• For optional Entities, they are simply removed
• For required Entities, this invalidates the entire response re-triggering suspense.