Using Typescript for defining regular expressions as enum values

Question

Using Typescript for defining regular expressions as enum values

When making API calls from an API in typescript, I want to clarify how the response should look by using an interface. One particular value is a string that can only have specific values. Isn't this what enums are for?

The possible values are:

"Normal Goal", "Own Goal", "Penalty", "Missed Penalty", 
"Yellow Card", "Second Yellow Card", "Red Card",
"Substitution x"

where x can be any positive integer. The challenge lies in implementing this. I attempted to use Regex, like so:

enum Event {
  "Normal Goal", "Own Goal", "Penalty", "Missed Penalty", 
  "Yellow Card", "Second Yellow Card", "Red Card",
  "Substitution [1-9]\d*$"
}

Unfortunately, this approach didn't work as expected. If this method proves impossible, I may have to change the enum to a string type. Do you have any alternative suggestions for achieving this?

regex typescript enums

Answer 1

Answer №1

If you want to streamline your code, consider using a single regular expression that covers all possible values instead of an enum. This way, you can check the value at runtime:

const event : RegExp = /(?:^|(?<= ))(Normal Goal|Own Goal|Penalty|Missed Penalty|Yellow Card|Second Yellow Card|Red Card|Substitution [1-9]\d*$)(?:(?= )|$)/

However, if you prefer to use a type for specific literals, then you will need to elaborate on the regex in your type definition:

type MatchEvent = 
        "Normal Goal"|
        "Own Goal"|
        "Penalty"|
        "Missed Penalty"|
        "Yellow Card"|
        "Second Yellow Card"|
        "Red Card"|
        "Substitution 1"|
        "Substitution 2"|
        ...
        "Substitution 99";

Answer 2

If you want to streamline your code, consider using a single regular expression that covers all possible values instead of an enum. This way, you can check the value at runtime:

const event : RegExp = /(?:^|(?<= ))(Normal Goal|Own Goal|Penalty|Missed Penalty|Yellow Card|Second Yellow Card|Red Card|Substitution [1-9]\d*$)(?:(?= )|$)/

However, if you prefer to use a type for specific literals, then you will need to elaborate on the regex in your type definition:

type MatchEvent = 
        "Normal Goal"|
        "Own Goal"|
        "Penalty"|
        "Missed Penalty"|
        "Yellow Card"|
        "Second Yellow Card"|
        "Red Card"|
        "Substitution 1"|
        "Substitution 2"|
        ...
        "Substitution 99";

Answer 3

Answer №2

Big shoutout to Christian for inspiring me to think outside the box and ditch the enum approach. I ended up creating my own custom type that can handle either predefined "enum strings" or a RegEx pattern.

Here's what my updated code looks like:

type Event = ("Normal Goal"|"Own Goal"|"Penalty"|"Missed Penalty"|"Yellow Card"|"Second Yellow Card"|"Red Card"|"Substitution [1-9]\d*$)(?:(?= )|"$);

interface I {
  test: Event
}

Answer 4

Big shoutout to Christian for inspiring me to think outside the box and ditch the enum approach. I ended up creating my own custom type that can handle either predefined "enum strings" or a RegEx pattern.

Here's what my updated code looks like:

type Event = ("Normal Goal"|"Own Goal"|"Penalty"|"Missed Penalty"|"Yellow Card"|"Second Yellow Card"|"Red Card"|"Substitution [1-9]\d*$)(?:(?= )|"$);

interface I {
  test: Event
}

Using Typescript for defining regular expressions as enum values

Answer №1

Answer №2

Similar questions

Steps to utilize redux in a fresh react class component

Determine the return value of a function based on a specific conditional parameter

Unable to use console log in shorthand arrow function while working with Typescript

Ionic has been experiencing issues with inaccurate boolean results being generated by Angular typescript

Utilize an Angular HttpInterceptor to invoke a Promise

Is there a way to dynamically retrieve a JSON element in Typescript?

Unable to narrow down the truthiness within nested functions: TypeScript issue

Ways to differentiate between the sources of two cold Observables (not just the possible data streams they may produce)

In Python, you can utilize the re.search function to find occurrences of opening and closing brackets

Enhance Tuple in Angular Component Properties

The MUI datagrid fails to display any rows even though there are clearly rows present

Ways to generate an array containing the headings from a list using typescript?

What are the steps to set up a dictionary with predetermined values?

Managing errors when dealing with Observables that are being replayed and have a long lifespan

Trouble encountered while configuring and executing Electron combined with React, Typescript, and Webpack application

The conditional type in TypeScript is malfunctioning

Traversing a sequence of method calls within a Promise object (as the return type)

Guide to slicing strings specifically with numerical characters at the end

Circular structure error occurred when attempting to convert an object to JSON, starting at an object constructed with the constructor 'Object'

"Utilizing generic types with the 'extends' keyword to input arguments into a function that requires a more specific