From af09a9cc1b8cf446272abd85b33210da2e895314 Mon Sep 17 00:00:00 2001 From: Brian White Date: Mon, 29 Feb 2016 21:03:14 -0500 Subject: [PATCH] doc: fix crypto update() signatures PR-URL: https://github.com/nodejs/node/pull/5500 Reviewed-By: Shigeki Ohtsu --- doc/api/crypto.markdown | 35 +++++++++++++++++++++++++---------- 1 file changed, 25 insertions(+), 10 deletions(-) diff --git a/doc/api/crypto.markdown b/doc/api/crypto.markdown index 2a50008cc13fc0..56e4a4628ff5b5 100644 --- a/doc/api/crypto.markdown +++ b/doc/api/crypto.markdown @@ -669,10 +669,15 @@ provided a string is returned; otherwise a [`Buffer`][] is returned; The `Hmac` object can not be used again after `hmac.digest()` has been called. Multiple calls to `hmac.digest()` will result in an error being thrown. -### hmac.update(data) +### hmac.update(data[, input_encoding]) -Update the `Hmac` content with the given `data`. This can be called -many times with new data as it is streamed. +Updates the `Hmac` content with the given `data`, the encoding of which +is given in `input_encoding` and can be `'utf8'`, `'ascii'` or +`'binary'`. If `encoding` is not provided, and the `data` is a string, an +encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then +`input_encoding` is ignored. + +This can be called many times with new data as it is streamed. ## Class: Sign @@ -733,10 +738,15 @@ returned. The `Sign` object can not be again used after `sign.sign()` method has been called. Multiple calls to `sign.sign()` will result in an error being thrown. -### sign.update(data) +### sign.update(data[, input_encoding]) + +Updates the `Sign` content with the given `data`, the encoding of which +is given in `input_encoding` and can be `'utf8'`, `'ascii'` or +`'binary'`. If `encoding` is not provided, and the `data` is a string, an +encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then +`input_encoding` is ignored. -Updates the sign object with the given `data`. This can be called many times -with new data as it is streamed. +This can be called many times with new data as it is streamed. ## Class: Verify @@ -780,10 +790,15 @@ console.log(verify.verify(public_key, signature)); // Prints true or false ``` -### verifier.update(data) +### verifier.update(data[, input_encoding]) -Updates the verifier object with the given `data`. This can be called many -times with new data as it is streamed. +Updates the `Verify` content with the given `data`, the encoding of which +is given in `input_encoding` and can be `'utf8'`, `'ascii'` or +`'binary'`. If `encoding` is not provided, and the `data` is a string, an +encoding of `'utf8'` is enforced. If `data` is a [`Buffer`][] then +`input_encoding` is ignored. + +This can be called many times with new data as it is streamed. ### verifier.verify(object, signature[, signature_format]) @@ -811,7 +826,7 @@ or [buffers][`Buffer`]. The default value is `'buffer'`, which makes methods default to [`Buffer`][] objects. The `crypto.DEFAULT_ENCODING` mechanism is provided for backwards compatibility -with legacy programs that expect `'utf8'` to be the default encoding. +with legacy programs that expect `'binary'` to be the default encoding. New applications should expect the default to be `'buffer'`. This property may become deprecated in a future Node.js release.