docs: refine requestSmsCode api doc & ts definition (#612)

and other minor changes (typos, zh -> en)

Co-authored-by: Lee Yeh <[email protected]>

Author: weakish

src/cloudfunction.js

@@ -77,12 +77,13 @@ module.exports = function(AV) {
       },
 
       /**
-       * Makes a call to request a sms code for operation verification.
+       * Makes a call to request an sms code for operation verification.
        * @param {String|Object} data The mobile phone number string or a JSON
        *    object that contains mobilePhoneNumber,template,sign,op,ttl,name etc.
        * @param {String} data.mobilePhoneNumber
        * @param {String} [data.template] sms template name
        * @param {String} [data.sign] sms signature name
+       * @param {String} [data.smsType] sending code by `sms` (default) or `voice` call
        * @param {SMSAuthOptions} [options]
        * @return {Promise} A promise that will be resolved if the request succeed
        */

src/file.js

@@ -71,7 +71,7 @@ module.exports = function(AV) {
    * @param data {Array} The data for the file, as either:
    *     1. an Array of byte value Numbers, or
    *     2. an Object like { base64: "..." } with a base64-encoded String.
-   *     3. a Blob(File) selected with a file upload control.
+   *     3. a Blob(File) { blob: {uri: "..."} } selected with a file upload control.
    *     4. a Buffer in Node.js runtime.
    *     5. a Stream in Node.js runtime.
    *

src/user.js

@@ -932,7 +932,7 @@ module.exports = function(AV) {
       },
 
       /**
-       * 检查该用户的登录状态是否有效，请注意该方法会校验 sessionToken 的有效性，是个异步方法。
+       * Detects if current sessionToken is valid.
        *
        * @since 2.0.0
        * @return Promise.<Boolean>
@@ -1104,7 +1104,7 @@ module.exports = function(AV) {
       },
 
       /**
-       * Sign up or logs in a user with a mobilePhoneNumber and smsCode.
+       * Signs up or logs in a user with a mobilePhoneNumber and smsCode.
        * On success, this saves the session to disk, so you can retrieve the currently
        * logged in user using <code>current</code>.
        *
@@ -1169,7 +1169,7 @@ module.exports = function(AV) {
       },
 
       /**
-       * Sign up or logs in a user with a third party auth data(AccessToken).
+       * Signs up or logs in a user with a third party auth data(AccessToken).
        * On success, this saves the session to disk, so you can retrieve the currently
        * logged in user using <code>current</code>.
        *
@@ -1206,7 +1206,7 @@ module.exports = function(AV) {
       },
 
       /**
-       * Sign up or logs in a user with a third party authData and unionId.
+       * Signs up or logs in a user with a third party authData and unionId.
        * @since 3.7.0
        * @param {Object} authData The response json data returned from third party token, maybe like { openid: 'abc123', access_token: '123abc', expires_in: 1382686496 }
        * @param {string} platform Available platform for sign up.

storage.d.ts

@@ -1220,7 +1220,7 @@ export namespace Cloud {
   function requestSmsCode(
     data:
       | string
-      | { mobilePhoneNumber: string; template?: string; sign?: string },
+      | { mobilePhoneNumber: string; template?: string; sign?: string; smsType?: 'sms' | 'voice' },
     options?: SMSAuthOptions
   ): Promise<void>;
   function verifySmsCode(code: string, phone: string): Promise<void>;