Skip to content

Commit a193d7c

Browse files
Trotttargos
authored andcommitted
doc: alphabetize crypto Cipher class entries
PR-URL: #37450 Reviewed-By: Michaël Zasso <targos@protonmail.com> Reviewed-By: Gireesh Punathil <gpunathi@in.ibm.com> Reviewed-By: Darshan Sen <raisinten@gmail.com> Reviewed-By: Luigi Pinca <luigipinca@gmail.com>
1 parent 54b6f1b commit a193d7c

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

doc/api/crypto.md

+13-13
Original file line numberDiff line numberDiff line change
@@ -313,6 +313,19 @@ Once the `cipher.final()` method has been called, the `Cipher` object can no
313313
longer be used to encrypt data. Attempts to call `cipher.final()` more than
314314
once will result in an error being thrown.
315315

316+
### `cipher.getAuthTag()`
317+
<!-- YAML
318+
added: v1.0.0
319+
-->
320+
321+
* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM`
322+
and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a
323+
[`Buffer`][] containing the _authentication tag_ that has been computed from
324+
the given data.
325+
326+
The `cipher.getAuthTag()` method should only be called after encryption has
327+
been completed using the [`cipher.final()`][] method.
328+
316329
### `cipher.setAAD(buffer[, options])`
317330
<!-- YAML
318331
added: v1.0.0
@@ -334,19 +347,6 @@ length of the plaintext in bytes. See [CCM mode][].
334347

335348
The `cipher.setAAD()` method must be called before [`cipher.update()`][].
336349

337-
### `cipher.getAuthTag()`
338-
<!-- YAML
339-
added: v1.0.0
340-
-->
341-
342-
* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM`
343-
and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a
344-
[`Buffer`][] containing the _authentication tag_ that has been computed from
345-
the given data.
346-
347-
The `cipher.getAuthTag()` method should only be called after encryption has
348-
been completed using the [`cipher.final()`][] method.
349-
350350
### `cipher.setAutoPadding([autoPadding])`
351351
<!-- YAML
352352
added: v0.7.1

0 commit comments

Comments
 (0)