The exported interface's property '<properyName>' is utilizing a private name '<name>'

Question

The exported interface's property '<properyName>' is utilizing a private name '<name>'

Here is a new interface declaration:

export interface ApiClientMetodOptions {
    initialFilterSatement?: string;
    fieldsMapping?: {
        [K in keyof P]?: string;
    };
    requestParams?: IRequestParams<P>;
    additionalParams?: {
        [key: string]: unknown;
    };
    additionalHeaders?: {
        [key: string]: string;
    };
    cancelOption?: IRequestCancelOption;
}

However, I encountered an error:

Property 'fieldsMapping' of exported interface has or is using private name 'P'.

I created this to encapsulate the type and use it in various methods. For example:

export interface IApiClient {
    /**
     * Generic function for fetching a list of a certain instances
     * @param fieldsMapping function converting fields of `P`-type object to a query field names
*/
getEntities<P, T>(
    url: string,
    options: {
        instanceToEntity?: (instance: unknown) => T;
    } & ApiClientMetodOptions,
): Promise<T[]>;

I am not very familiar with "typescript". What mistake am I making and how can I resolve this issue?

typescript interface encapsulation

Answer 1

Answer №1

To define the interface, ensure to include the P generic parameter as shown below:

export interface ApiClientMethodOptions<P> {
    initialFilterStatement?: string;
    fieldsMapping?: {
        [K in keyof P]?: string;
    };
    requestParams?: IRequestParams<P>;
    additionalParams?: {
        [key: string]: unknown;
    };
    additionalHeaders?: {
        [key: string]: string;
    };
    cancelOption?: IRequestCancelOption;
}

Next, in your method definition, remember to add the parameter accordingly:

export interface IApiClient {
    /**
     * Function that fetches a list of specific instances using generics
     * @param fieldsMapping Converts fields of type `P` to query field names
*/
getEntities<P, T>(
    url: string,
    options: {
        instanceToEntity?: (instance: unknown) => T;
    } & ApiClientMethodOptions<P>,
): Promise<T[]>;

Answer 2

To define the interface, ensure to include the P generic parameter as shown below:

export interface ApiClientMethodOptions<P> {
    initialFilterStatement?: string;
    fieldsMapping?: {
        [K in keyof P]?: string;
    };
    requestParams?: IRequestParams<P>;
    additionalParams?: {
        [key: string]: unknown;
    };
    additionalHeaders?: {
        [key: string]: string;
    };
    cancelOption?: IRequestCancelOption;
}

Next, in your method definition, remember to add the parameter accordingly:

export interface IApiClient {
    /**
     * Function that fetches a list of specific instances using generics
     * @param fieldsMapping Converts fields of type `P` to query field names
*/
getEntities<P, T>(
    url: string,
    options: {
        instanceToEntity?: (instance: unknown) => T;
    } & ApiClientMethodOptions<P>,
): Promise<T[]>;

The exported interface's property '<properyName>' is utilizing a private name '<name>'

Answer №1

Similar questions

Reusing methods in Javascript to create child instances without causing circular dependencies

Navigating to the main directory in Angular 2

Utilizing the useState hook with generics in React for efficient data management

What is preventing me from consistently accessing the Type Definition while my cursor is on a JavaScript/TypeScript parameter name in VS Code, and what are some strategies I can use to overcome this issue?

Seamless Navigation with Bootstrap Navbar and SmoothScroll

The Vue Prop does not have an initializer and is not explicitly assigned in the constructor

An error has occurred in Angular: No routes were found that match the URL segment 'null'

Error Encountered: Visual Studio cannot locate the file 'COMPUTE_PATHS_ONLY.ts' during the build process

What is the reason behind the never return value in this typescript template?

The NestJS server encounters an unhandled exception leading to a server

Error: User authentication failed: username: `name` field is mandatory

What is the best way to link three different types of http requests in succession and adaptively?

Dealing with an AWS S3 bucket file not found error: A comprehensive guide

Examining the asynchronous function to cause an error using mocha

The function database is not defined in firebase_compat_app__WEBPACK_IMPORTED_MODULE_0__.default

What is the reason behind the return type of 'MyType | undefined' for Array<MyType>.find(...) method?

Set certain properties within the nested object to be optional

Encountering a 404 (Not Found) error while trying to access a null resource in Angular at http://localhost

The use of async/await within an observable function

The browser is throwing errors because TypeScript is attempting to convert imports to requires during compilation