Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

MLIBZ-2314 Updated typescript definitions #242

Merged
merged 3 commits into from
Feb 21, 2018
Merged

MLIBZ-2314 Updated typescript definitions #242

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
82408d6
Updated typescript definitions.
tejasranade Feb 14, 2018
08bad59
Minor typo
tejasranade Feb 15, 2018
a27a973
more typescript fixes to RequestOptions
tejasranade Feb 19, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/kinvey.d.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,6 +26,7 @@ export namespace Kinvey {
timeout ? : number;
useDeltaFetch ? : boolean;
version ? : string;
micId? : string;
}

// ClientConfig interface
Expand Down Expand Up @@ -436,8 +437,8 @@ export namespace Kinvey {
static loginWithMIC(redirectUri: string, authorizationGrant ? : AuthorizationGrant, options ? : RequestOptions): Promise < User > ;
logout(options ? : RequestOptions): Promise < void > ;
static logout(options ? : RequestOptions): Promise < void > ;
signup(data: {}, options ? : RequestOptions): Promise < this > ;
static signup(data: {}, options ? : RequestOptions): Promise < User > ;
signup(data ? : {}, options ? : RequestOptions): Promise < this > ;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Shouldn't the data type of all of these be "any"?

Copy link
Contributor Author

@tejasranade tejasranade Feb 19, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I had to look this up. Turns out, there's a subtle difference - https://stackoverflow.com/questions/18961203/typescript-any-vs-object

Based on that article (see last note in this answer - https://stackoverflow.com/a/28795689), I feel using object is the most appropriate. Doesn't have to be in this PR, but {} is still better than any. We want to be as restrictive as possible, to avoid bad input. Thoughts?

Copy link
Contributor

@gprodanov gprodanov Feb 20, 2018 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I guess when defining a method argument in a definition file, we can use object (or {} which seems to be the same) and it is better. Although it still allows you to pass a function.

But don't we know even more about this object? Like it should have a username and password properties, no?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we do but it can also have much more then just these properties. Lets look at updating these definitions going forward but lets not hold up this change since currently it will throw and error if no data is provided.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Sure, I wasn't requesting changes at any point.

But the way to define the data type is something like this:

interface UserData {
  [key: string]: value: any
}

interface UserSignUpData extends UserData {
  username: string,
  password: string
}

This way you have the two properties, but can add as many more as you like.

static signup(data ? : {}, options ? : RequestOptions): Promise < User > ;
update(data: {}, options ? : RequestOptions): Promise < this > ;
static update(data: {}, options ? : RequestOptions): Promise < User > ;
me(options ? : RequestOptions): Promise < this > ;
Expand Down Expand Up @@ -544,6 +545,8 @@ interface RequestOptions {
properties?: Properties;
timeout?: number;
useDeltaFetch?: boolean;
version?: string;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This change should've been in my previous typescript PR #235 . I did not realize we had two copies of the ts definitions in the same file.

micId?: string;
}

// ClientConfig interface
Expand Down Expand Up @@ -944,8 +947,8 @@ export class User {
static loginWithMIC(redirectUri: string, authorizationGrant?: AuthorizationGrant, options?: RequestOptions): Promise<User>;
logout(options?: RequestOptions): Promise<void>;
static logout(options?: RequestOptions): Promise<void>;
signup(data: {}, options?: RequestOptions): Promise<this>;
static signup(data: {}, options?: RequestOptions): Promise<User>;
signup(data ? : {}, options?: RequestOptions): Promise<this>;
static signup(data ?: {}, options?: RequestOptions): Promise<User>;
update(data: {}, options?: RequestOptions): Promise<this>;
static update(data: {}, options?: RequestOptions): Promise<User>;
me(options?: RequestOptions): Promise<this>;
Expand Down