work-in-progress atproto PDS
typescript
atproto
pds
atcute
chore: enforce required parameters over optional
+7
+7
CLAUDE.md
+7
CLAUDE.md
···
28
28
- avoid barrel exports (index files that re-export from other modules); import directly from source
29
29
- use `// #region <name>` and `// #endregion` to denote regions when a file needs to contain a lot
30
30
of code
31
+
- prefer required parameters over optional ones; optional parameters are acceptable when:
32
+
- the default is obvious and used by the vast majority of callers (e.g., `encoding = 'utf-8'`)
33
+
- it's a configuration value with a sensible default (e.g., `timeout = 5000`)
34
+
- avoid optional parameters that change behavioral modes or make the function do different things
35
+
based on presence/absence; prefer separate functions instead
36
+
- when adding optional parameters for backwards compatibility, consider whether a new function with
37
+
a clearer name would be better
31
38
32
39
### documentation
33
40