Skip to content

Commit 5673889

Browse files
committed
fix typo on event -> events parameter
1 parent 633eedd commit 5673889

File tree

1 file changed

+3
-3
lines changed

1 file changed

+3
-3
lines changed

speech-to-text/v1.js

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ SpeechToTextV1.URL = 'https://stream.watsonplatform.net/speech-to-text/api';
9797
*
9898
* @param {object} params - The parameters
9999
* @param {string} params.callback_url - A URL to which callback notifications are to be sent
100-
* @param {string} params.user_secret - A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the X-Callback-Signature header
100+
* @param {string} [params.user_secret] - A user-specified string that the service uses to generate the HMAC-SHA1 signature that it sends via the X-Callback-Signature header
101101
* @param {Function} callback
102102
* @returns {ReadableStream|undefined}
103103
*/
@@ -131,7 +131,7 @@ SpeechToTextV1.prototype.registerCallback = function(params, callback) {
131131
* @param {Stream} params.audio - Audio to be recognized
132132
* @param {string} params.content_type - The Content-type e.g. audio/l16; rate=48000
133133
* @param {string} params.callback_url - A URL to which callback notifications are to be sent
134-
* @param {string} [params.event] - recognitions.started|recognitions.completed|recognitions.failed|recognitions.completed_with_results
134+
* @param {string} [params.events] - recognitions.started|recognitions.completed|recognitions.failed|recognitions.completed_with_results
135135
* @param {string} [params.user_token] - The token allows the user to maintain an internal mapping between jobs and notification events
136136
* @param {number} [params.results_ttl] - time to alive of the job result
137137
* @param {*} [params.*] - all params that .recognize() accepts may also be passed to createRecognitionJob()
@@ -157,7 +157,7 @@ SpeechToTextV1.prototype.createRecognitionJob = function(params, callback) {
157157
headers: {
158158
'Content-Type': params.content_type
159159
},
160-
qs: pick(params, ['callback_url', 'event', 'user_token', 'results_ttl'].concat(PARAMS_ALLOWED)),
160+
qs: pick(params, ['callback_url', 'events', 'user_token', 'results_ttl'].concat(PARAMS_ALLOWED)),
161161
json: true
162162
},
163163
defaultOptions: this._options

0 commit comments

Comments
 (0)