Type Alias ApiContract

ApiContract: Record<string, ApiGroup>

A typed API contract with one level of grouping.

Each key is a group name and each value is an ApiGroup — a record of named endpoints.

Example

const contract: ApiContract = {
    todos: { list: todosResource.get(), create: todosResource.post() },
    auth:  { login: endpoint.post('/api/auth/login') },
};

Type Alias ApiContract

Example

Settings