CODEWITHSUNDEEP
javascripttypescript
Kousha
Kousha

Reputation: 36219

TypeScript type string of specific characters

Let's say I want to allow a hex string; so the only allowed values would be 0-9a-f. Is there a way in TypeScript to define a type string that only takes certain strings? i.e.

// valid
const valid: HexString = '123abc';
// invalid
const invalid: HexString = 'ijk';

I know Regex type definitions is a proposal here, was wondering if there was a way to achieve this in the meantime.

Upvotes: 6

Views: 4740

Answers (1)

Shanon Jackson
Shanon Jackson

Reputation: 6531

Only with "OpaqueTypes" or "Nominal Types" aslong as you have an implementation that can make a string a HexCode the implementation is as follows.

export type Opaque<K, T> = T & { __TYPE__: K };
type HexCode = Opaque<string, "HexCode">

const createHexCode = (str: string): HexCode => {
  // implementation that forces string to be hexCode
  return str.toString() as HexCode // casting is needed.
}
const test = createHexCode("#333");
const isAssignableString: string = test; // yes anything that is HexCode is still technically a string.
const isAssignableHexCode: HexCode = "standard string" // error

this pattern is also useful for things like PositiveInteger and PasswordHash where you don't want anyone to accidentally assign a plain-string to that value you want to force people to use a function that returns a PasswordHash

Upvotes: 8

Related Questions