Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
25 changes: 25 additions & 0 deletions docs/contributing/code-style/enums.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# TypeScript Const Enums

We don't use Typescript enums because they are not fully type-safe and can cause surprises. Instead
of using enums, we use constant objects.

## Our Recommended Approach

```ts
export const PasskeyActions = {
Register: "register",
Authenticate: "authenticate",
} as const;

export type PasskeyActionValue = (typeof PasskeyActions)[keyof typeof PasskeyActions];

declare function usePasskeyAction(action: PasskeyActionValue): void;

usePasskey(PasskeyActions.Register); // โœ… Valid
usePasskey(0); // โŒ Invalid
```

## Resources Used

- https://dev.to/ivanzm123/dont-use-enums-in-typescript-they-are-very-dangerous-57bh
- https://www.typescriptlang.org/docs/handbook/enums.html#objects-vs-enums