Skip to content

doc/crypto: include options and correct return type for setAAD() #21420

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
ZaneHannanAU wants to merge 4 commits into from
Closed

doc/crypto: include options and correct return type for setAAD() #21420

Changes from 1 commit
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
1ca372f
Ensure most Decipher methods return Decipher; not Cipher
ZaneHannanAU Jun 20, 2018
9de6ebf
Remove unadded AADOptions type
ZaneHannanAU Jun 20, 2018
94cb48f
Add `plaintextLength` to `setAAD` options
ZaneHannanAU Jun 24, 2018
f8a6090
Fix misspelling, wordlinting mistake.
ZaneHannanAU Jun 24, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Prev Previous commit
Next Next commit
Add plaintextLength to setAAD options
  • Loading branch information
@ZaneHannanAU
ZaneHannanAU authored Jun 24, 2018
commit 94cb48fee57ecd8e079dd56d78d96d274c811e97
6 changes: 4 additions & 2 deletions doc/api/crypto.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -245,7 +245,8 @@ once will result in an error being thrown.
added: v1.0.0
-->
- `buffer` {Buffer}
- `options` {Object}
- `options` {Object} [`stream.transform` options][]
- `plaintextLength`: {nunmber}
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Jun 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Nit: delete colon and {nunmber} -> {number} so we can run the last CI)

- Returns: {Cipher} for method chaining.

When using an authenticated encryption mode (only `GCM` and `CCM` are currently
Expand Down Expand Up @@ -407,7 +408,8 @@ changes:
description: This method now returns a reference to `decipher`.
-->
- `buffer` {Buffer | TypedArray | DataView}
- `options` {Object}
- `options` {Object} [`stream.transform` options][]
- `plaintextLength`: {nunmber}
Copy link
Copy Markdown
Contributor

@vsemozhetbyt vsemozhetbyt Jun 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The same)

Copy link
Copy Markdown
Contributor Author

@ZaneHannanAU ZaneHannanAU Jun 24, 2018

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done :

- Returns: {Decipher} for method chaining.

When using an authenticated encryption mode (only `GCM` and `CCM` are currently
Expand Down