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.

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

MLIBZ-2314 Updated typescript definitions #242

Merged
merged 3 commits into from Feb 21, 2018

Conversation

@tejasranade
Copy link
Member

commented Feb 15, 2018

Description

Updated definition of signup() to allow zero parameters (required to signup as implicit user)

Changes

Minor change to .ts file.

tejasranade added 2 commits Feb 14, 2018
@@ -544,6 +544,7 @@ interface RequestOptions {
properties?: Properties;
timeout?: number;
useDeltaFetch?: boolean;
version?: string;

This comment has been minimized.

Copy link
@tejasranade

tejasranade Feb 15, 2018

Author Member

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.

@@ -436,8 +436,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 > ;

This comment has been minimized.

Copy link
@georgiwe

georgiwe Feb 16, 2018

Contributor

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

This comment has been minimized.

Copy link
@tejasranade

tejasranade Feb 19, 2018

Author Member

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?

This comment has been minimized.

Copy link
@georgiwe

georgiwe Feb 20, 2018

Contributor

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?

This comment has been minimized.

Copy link
@thomasconner

thomasconner Feb 21, 2018

Contributor

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.

This comment has been minimized.

Copy link
@georgiwe

georgiwe Feb 22, 2018

Contributor

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.

@thomasconner thomasconner self-requested a review Feb 21, 2018

@thomasconner thomasconner merged commit 53fc63b into master Feb 21, 2018

1 of 2 checks passed

continuous-integration/travis-ci/pr The Travis CI build failed
Details
continuous-integration/travis-ci/push The Travis CI build passed
Details

@thomasconner thomasconner deleted the MLIBZ-2314_signup_typescript branch Feb 21, 2018

kinson added a commit to cbre360/js-sdk that referenced this pull request Feb 26, 2018
MLIBZ-2314 Updated typescript definitions (Kinvey#242)
* Updated typescript definitions.

* Minor typo

* more typescript fixes to RequestOptions
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
3 participants
You can’t perform that action at this time.