Interface Entity<TData, TLinks>

Example

import { Entity, Collection } from '@hateoas-ts/resource';

// Simple entity with self link
type Post = Entity<
  { id: string; title: string; content: string },
  { self: Post; author: User }
>;

// Entity with collection links and action links
type User = Entity<
  { id: string; name: string; email: string },
  {
    self: User;
    posts: Collection<Post>;
    'create-post': Post;  // Action link (has HAL-Forms template)
  }
>;

// Usage
const user = await client.go<User>('/users/123').get();
console.log(user.data.name);  // Type-safe access to data
const posts = await user.follow('posts').get();  // Type-safe link navigation

// Execute action through link relation
if (user.hasActionFor('create-post')) {
  const action = user.actionFor('create-post');
  await action.submit({ title: 'New Post' });
}
Copy