SpoonX / aurelia-authentication

Authentication plugin for aurelia.
http://aurelia-authentication.spoonx.org
MIT License
90 stars 60 forks source link

Read.me API documentation wrong #418

Closed bmarotta closed 3 years ago

bmarotta commented 4 years ago

The API documentation in the readme.md

// link third-party account or log into server via third-party authentication. Stores response if successful
  authenticate(name, redirectUri, userData)

Doesn't match the code:

/**
   * Authenticate with third-party
   *
   * @param {string}    name        Name of the provider
   * @param {[{}]}      [userData]  Additional data send to the authentication server
   *
   * @return {Promise<any>} The authentication server response
   */
  authenticate(name: string, userData: {} = {}): Promise<any> {
RWOverdijk commented 4 years ago

Feel free to make a PR :)