Incorrect parameters to authorize in docs

[objectiveSee]

Checklist

• The issue can be reproduced in the react-native-auth0 sample app (or N/A).
• I have looked into the Readme, Examples, and FAQ and have not found a suitable solution or answer.
• I have looked into the API documentation and have not found a suitable solution or answer.
• I have searched the issues and have not found a suitable solution or answer.
• I have searched the Auth0 Community forums and have not found a suitable solution or answer.
• I agree to the terms within the Auth0 Code of Conduct.

Description

In README, the example you have provided for using authorize() is not correct. There are two required parameters which cannot be omited in Typescript.

https://github.com/auth0/react-native-auth0/blob/master/README.md?plain=1#L280

The correct usage would be:

authorize({},{})

Empty objects must be passed because parameters and options are not optional.

Solution: Update docs. Or, update authorize to take a single object with optional parameters such as:

Change this:

  authorize: (
    parameters: WebAuthorizeParameters,
    options: WebAuthorizeOptions
  ) => Promise<Credentials | undefined>;

to this:

  authorize: ({
        parameters?: WebAuthorizeParameters,
        options?: WebAuthorizeOptions
    }
  ) => Promise<Credentials | undefined>;

Reproduction

See README

Additional context

No response

react-native-auth0 version

3.0.0

React Native version

72.3

Expo version

49

Platform

Android, iOS

Platform version(s)

any

[objectiveSee]

clearSession has the same bug in docs: https://github.com/auth0/react-native-auth0#logout

[felipem292]

hi do you know why login did not redirect in android when logins was Successful?

[poovamraj]

@objectiveSee thanks a lot for raising this. We will make the API cleaner to use.

[poovamraj]

@felipem292 can you create a seperate issue with more details?

[poovamraj]

@objectiveSee thanks for reporting this. We have fixed this in this PR - #701

Please check it out and let us know your feedback. We will close this issue to continue the conversation in the PR.

[ysheep-js]

hi do you know why login did not redirect in android when logins was Successful?

Same issue here, is there any feedback?

[poovamraj]

@ysheep-js we would require more details. Can you create a seperate Github issue with more details asked in the issues template.

[ysheep-js]

@ysheep-js we would require more details. Can you create a seperate Github issue with more details asked in the issues template.

Ok, I'll create a new one, thanks.

[poovamraj]

@ysheep-js @felipem292 Did you follow the migration guide on updating the callback URL?

[ysheep-js]

@ysheep-js @felipem292 Did you follow the migration guide on updating the callback URL?

Yes, I have added .auth0 suffix

[poovamraj]

@ysheep-js It would be helpful if you can share the code snippet, a screen recording, whether this issue is happening only in version 3.0.0 and more details we would be happy to help. Please create a seperate GH issue to make it easier to track

[felipem292]

i'm using "react-native-auth0": "^2.17.4"
IOS is working perfect