Create type-safe distinct primitives in TypeScript using phantom branding.
npx skills add https://github.com/wellcrafted-dev/wellcrafted --skill branded-types
Please help me install this Agent Skill. Skill: branded-types Source: https://github.com/wellcrafted-dev/wellcrafted/tree/main/skills/branded-types Command: npx skills add https://github.com/wellcrafted-dev/wellcrafted --skill branded-types
This Skill solves the problem of TypeScript's structural typing allowing interchangeable primitive types (like strings or numbers) that should be distinct, preventing accidental misuse of values like user IDs and order IDs.
UserId and OrderId as distinct types, ensuring that a function expecting a UserId cannot accidentally receive an OrderId.Use the branded-types skill to create a new type ProductId that is a string and cannot be confused with other strings.
High-intent search queries and answers about installing and using this skill.
To prevent TypeScript from treating different string IDs as the same type, you can use branded types to implement nominal typing, creating distinct types like UserId and OrderId that cannot be accidentally interchanged at compile time.
The brand constructor pattern in TypeScript provides a centralized source of truth for creating branded types, allowing you to define distinct primitives and optionally include runtime validation to ensure type safety and data integrity.
You create nominal types in TypeScript by applying phantom branding to primitive values, which structurally separates identical primitives like strings or numbers so they cannot be mistakenly assigned to one another.
You need to use branded types in TypeScript when structural typing causes accidental interchangeability of similar primitives, such as mixing up different kinds of IDs or tokens in function parameters and variable assignments.
Yes, you can add runtime validation when creating distinct primitive types by utilizing the brand constructor pattern, which supports optional validation checks to verify data integrity alongside compile-time type safety.
Yes, TypeScript structural typing allows mixing different ID types because it compares shape rather than identity, but branded types solve this by adding phantom branding to enforce strict nominal typing and prevent accidental misuse.
cmbaysEnforce strict TypeScript type safety by eliminating `any` types and resolving compiler errors.
dadbodgeoffConfigure TypeScript projects with strict type checking and safety flags.
cyoteeDecode and validate Ethereum data into branded Uint8Array types in TypeScript using Voltaire primitives and Effect Schema workflows.
JustinRoderickApply branded nominal typing with validated constructors to TypeScript values.