CODEWITHSUNDEEP
javascripttypescript
Kousha
Kousha

Reputation: 36199

Typescript argument check against a union type

I want to check if a string has a prefix that matches a union type, eg:

type Prefix = "ABC" | "DEF" | "GHI" ...;
const hasPrefix = (str: string): boolean => {
   // I want to check the first 3 characters of the string
   // And see if it matches any of the Prefix
   // Something like
   //  if (str.substr(0, 3) === Prefix)
}

Upvotes: 3

Views: 453

Answers (2)

Alex
Alex

Reputation: 907

In the current version of TypeScript you can't dissect a union type. For your problem I would recommend an approach using enums like so:

enum Prefixes {
    "ABC",
    "DEF",
    "GHI"
}

const hasPrefix = (str: string): boolean => Prefixes[str.substr(0, 3) as any] !== "undefined";

console.log(hasPrefix("123")); // false
console.log(hasPrefix("ABC")); // true
console.log(hasPrefix("DEF")); // true
console.log(hasPrefix("GHI")); // true
console.log(hasPrefix("GHII"));// true

const data = "ABC123";         // ABC123

console.log(hasPrefix(data));  // true
console.log(data);             // still ABC123

Here's a TypeScript playground of the above code.

Judging by your question you seem to be interested in a dynamic way to check for prefixes (the ... characters imply this (?)). This got me thinking and came up with a solution using a Set data type. Consider this example:

// Set data type ensures only uniques
type Prefix = string;
const prefixes: Set<Prefix> = new Set();

prefixes.add("ABC");
prefixes.add("ABC");
prefixes.add("DEF");
prefixes.add("GHI");

// No doubles here so we're good (note the double added ABC string)
console.log(prefixes);

// the typeguard
const hasPrefix = (str: any): str is Prefix => typeof str === "string" ? prefixes.has(str.substr(0, 3)): false;

console.log(hasPrefix(100));   // false
console.log(hasPrefix(0));     // false
console.log(hasPrefix(false)); // false
console.log(hasPrefix(true));  // false
console.log(hasPrefix(""));    // false
console.log(hasPrefix("123")); // false
console.log(hasPrefix("ABC")); // true
console.log(hasPrefix("DEF")); // true
console.log(hasPrefix("GHI")); // true
console.log(hasPrefix("GHII"));// true

const data = "ABC123";         // ABC123

if (hasPrefix(data)) {
    console.log(hasPrefix(data));  // true
    console.log(data);             // still ABC123
}

Here's the playground for that code.

Upvotes: 2

Georgy
Georgy

Reputation: 2462

I think it is not possible at the moment just with built-in Typescript types. https://github.com/Microsoft/TypeScript/issues/6579 and for reference to proposals: How to define a regex-matched string type in Typescript?

Upvotes: 2

Related Questions