Interface for string field in typescript

Question

I have a function whichYogaDoYouPractice that accepts a parameter type. The value of type can be any one of hatha, kriya, bhakti, jnana. Currently, I have my function written as follows:

function whichYogaDoYouPractice(type:'hatha'|'kriya'|'bhakti'|'jnana'){
 ...
}

I have more such functions where I want to use the parameter type for the above-mentioned values. I don't wish to mention all 4 type's every time I declare a function. I want to create an interface so my function looks something like the below function:

function whichYogaDoYouPractice(type:YogaType){
 ...
}

I can create interface for objects like below:

export interface ObjectInterface{
 id:string;
 name:string;
}

But I want to create an interface only for a string that can only be of any of the 4 values I mention in the interface so that I can use it with one word YogaType for the above example. Is it possible in Typescript? If yes, how? Thank You!

akuiper · Accepted Answer · 2021-09-26 18:28:58Z

2

You can just create a union type:

type YogaType = 'hatha'|'kriya'|'bhakti'|'jnana'

function whichYogaDoYouPractice(type: YogaType){
}

Playground

Or create a enum:

enum Yoga {
  hatha,
  kriya,
  bhakti,
  jnana
}

function whichYogaDoYouPractice2(type: Yoga){
}

answered Sep 26, 2021 at 18:28

akuiper

216k33 gold badges362 silver badges379 bronze badges

Sign up to request clarification or add additional context in comments.

Collectives™ on Stack Overflow

Interface for string field in typescript

1 Answer 1

Comments

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

Comments

Your Answer

Sign up or log in

Post as a guest

Related