"Defining the structure of object parameters in a function using type

Question

What is the correct way to set typing for object style parameters?

The function signature I have is as follows:

private buildURI({ endpoint params }): void {

}

Typescript is throwing an error for missing typings, so I attempted the following:

private buildURI({ endpoint:string, params: any[] }): void { }

I also tried this approach:

private buildURI({ endpoint, params }: { string, any[]}): void { }

However, neither of these methods worked. The only method that works is:

private buildURI({ endpoint, params }: any ): void { }

Yet, this does not seem to be a valid solution.

So, how can I properly set this method with valid typing?

Answer 1

Answer №1

The proper way to configure "object-styled" (referred to as destructed parameters) is outlined below.

private buildURI({ endpoint, params }: { endpoint: string, params: any[] })

This has been a commonly discussed issue highlighted here.

Alternatively, you can create an interface first and then utilize it.

interface UriOptions {
  endpoint: string
  params: any[]
}

private buildURI({ endpoint, params }: UriOptions)

Answer 2

The proper way to configure "object-styled" (referred to as destructed parameters) is outlined below.

private buildURI({ endpoint, params }: { endpoint: string, params: any[] })

This has been a commonly discussed issue highlighted here.

Alternatively, you can create an interface first and then utilize it.

interface UriOptions {
  endpoint: string
  params: any[]
}

private buildURI({ endpoint, params }: UriOptions)

Answer 3

Creating a custom type with properties for endpoint and params is recommended:

type GenerateUrlParams = {
    endpoint: string,
    params: any[]
}

function generateURL({ endpoint, params }: GenerateUrlParams): void { }

Answer 4

Creating a custom type with properties for endpoint and params is recommended:

type GenerateUrlParams = {
    endpoint: string,
    params: any[]
}

function generateURL({ endpoint, params }: GenerateUrlParams): void { }