Custom property on User object is not optional

[Donivanes]

If you're not sure whether your problem is specifically related to this repository, or to the ConfigCat service overall, please contact the ConfigCat support. This issue tracker is intended only for feedback on the content of this repository.

Describe the bug

I don't know if it's intentional or not, but when doing a feature flag targeting users on the documentation the custom param is optional but in the types of it it's required.

User.d.ts

export declare class User implements IUser {
    identifier: string;
    email?: string | undefined;
    country?: string | undefined;
    custom: Record<string, UserAttributeValue>;
    constructor(identifier: string, email?: string | undefined, country?: string | undefined, custom?: Record<string, UserAttributeValue>);
}

Expected behavior

Not to be required

Screenshots

If applicable, add screenshots to help explain your problem.

[adams85]

Hi @Donivanes,

Thank you for reporting this issue.

The User class was kind of a design mistake, it should have been declared as an interface in the first place.

This problem was addressed by the new ConfigCat SDK for JavaScript (@configcat/sdk). It accepts the IUser interface now, which is implemented by the User class. But the class exists only for backward compatibility, it's not recommended to use it in newly written code.

However, this change hasn't been carried over to the React SDK, it still expects the class type in its public API. We will fix this soon.

Until then, you can use the User class, but you need to instantiate it via the constructor:

const user = new User("12345" /* ... */);

The constructor doesn't require the custom parameter.

Although this is allowed by TypeScript, it's incorrect (because it doesn't set the prototype):

const user: User = { identifier: "12345" /* ... */ };

If you spot a code example like this in our documentation, please let us know.

[Donivanes]

@adams85 thank you! 👍🏼

[adams85]

A new version of the SDK addressing the issue is now available in NPM.