API Resources

1import { JsonResource } from "canxjs";
2
3export class UserResource extends JsonResource {
4  toArray(request) {
5    return {
6      id: this.id,
7      name: this.name,
8      email: this.email,
9      created_at: this.created_at,
10      // Computed or conditional attributes
11      is_admin: this.role === 'admin'
12    };
13  }
14}

1import { UserResource } from "./resources/UserResource";
2
3app.get("/user/:id", async (req, res) => {
4  const user = await User.find(req.params.id);
5  
6  // Return single resource
7  return new UserResource(user);
8});
9
10app.get("/users", async (req, res) => {
11  const users = await User.all();
12  
13  // Return collection
14  return UserResource.collection(users);
15});

1// In PostResource.ts
2export class PostResource extends JsonResource {
3  toArray(request) {
4    return {
5      id: this.id,
6      title: this.title,
7      content: this.content,
8      // Nesting user resource
9      author: new UserResource(this.author),
10      // Conditional Relationship
11      comments: this.whenLoaded('comments', () => CommentResource.collection(this.comments)),
12    };
13  }
14}