wip library to store cold objects in s3, warm objects on disk, and hot objects in memory
nekomimi.pet
nodejs
typescript
1You are working on a project that stores cold objects in s3, warm objects on disk, and hot objects in memory. It serves APIs for library consumers to use.
2
3## Package management
4- Use bun for package management (bun install)
5- Use npm run test to test
6- Use npm run lint to lint
7- Use npm run check to typecheck
8
9Please test and typecheck always whenever you think you are done.
10
11## Code style
12- Use tabs for indentation, spaces allowed for diagrams in comments
13- Use single quotes and add trailing commas
14- Use template literals for user-facing strings and error messages
15
16## Commenting
17Add JSDoc comments to all new exported functions, methods, classes, fields, and enums
18JSDoc should include proper annotations:
19- use @param for parameters (no dashes after param names)
20- use @returns for return values
21- use @throws for exceptions when applicable
22- keep descriptions concise but informative
23
24## Misc
25the .research/ directory serves as a workspace for temporary experiments, analysis, and planning materials. create it if necessary (it's gitignored). this directory may contain cloned repositories or other reference materials that can help inform implementation decisions
26
27**don't make assumptions or speculate about code, plans, or requirements without exploring first; pause and ask for clarification when you're still unsure after looking into it**