Skip to content

Commit

Permalink
doc: fix crypto update() signatures
Browse files Browse the repository at this point in the history
PR-URL: #5500
Reviewed-By: Shigeki Ohtsu <ohtsu@iij.ad.jp>
  • Loading branch information
mscdex committed Mar 18, 2016
1 parent 1cf26c0 commit af09a9c
Showing 1 changed file with 25 additions and 10 deletions.
35 changes: 25 additions & 10 deletions doc/api/crypto.markdown
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down Expand Up @@ -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

Expand Down Expand Up @@ -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])

Expand Down Expand Up @@ -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.
Expand Down

0 comments on commit af09a9c

Please sign in to comment.