Skip to content

Commit e6f804b

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 bb434a9 commit e6f804b

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
@@ -282,6 +282,19 @@ Once the `cipher.final()` method has been called, the `Cipher` object can no
282282
longer be used to encrypt data. Attempts to call `cipher.final()` more than
283283
once will result in an error being thrown.
284284

285+
### `cipher.getAuthTag()`
286+
<!-- YAML
287+
added: v1.0.0
288+
-->
289+
290+
* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM`
291+
and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a
292+
[`Buffer`][] containing the _authentication tag_ that has been computed from
293+
the given data.
294+
295+
The `cipher.getAuthTag()` method should only be called after encryption has
296+
been completed using the [`cipher.final()`][] method.
297+
285298
### `cipher.setAAD(buffer[, options])`
286299
<!-- YAML
287300
added: v1.0.0
@@ -302,19 +315,6 @@ of the plaintext in bytes. See [CCM mode][].
302315

303316
The `cipher.setAAD()` method must be called before [`cipher.update()`][].
304317

305-
### `cipher.getAuthTag()`
306-
<!-- YAML
307-
added: v1.0.0
308-
-->
309-
310-
* Returns: {Buffer} When using an authenticated encryption mode (`GCM`, `CCM`
311-
and `OCB` are currently supported), the `cipher.getAuthTag()` method returns a
312-
[`Buffer`][] containing the _authentication tag_ that has been computed from
313-
the given data.
314-
315-
The `cipher.getAuthTag()` method should only be called after encryption has
316-
been completed using the [`cipher.final()`][] method.
317-
318318
### `cipher.setAutoPadding([autoPadding])`
319319
<!-- YAML
320320
added: v0.7.1

0 commit comments

Comments
 (0)