chore: move args for createEncoder into non-repeating options & fix typedoc
#1146
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
size-limit report 📦
|
fryorcraken
reviewed
Feb 7, 2023
| contentTopic: string, | ||
| ephemeral = false | ||
| ): Encoder { | ||
| export function createEncoder({ |
There was a problem hiding this comment.
Do we think we want to accept string | EncoderOptions so most of the time, the developer just pass the content topic string and only pass an object in advance usage?
WDYT @hackyguru ?
| @@ -63,6 +64,13 @@ export class Encoder implements IEncoder { | |||
| } | |||
| } | |||
|
|
|||
| export interface EciesEncoderOptions extends EncoderOptions { | |||
There was a problem hiding this comment.
IMO we are in the ecies package so the Ecies prefix is not needed.
| @@ -61,6 +62,13 @@ export class Encoder implements IEncoder { | |||
| } | |||
| } | |||
|
|
|||
| export interface SymmetricEncoderOptions extends EncoderOptions { | |||
There was a problem hiding this comment.
IMO we are in the symmetric package so the Symmetric prefix is not needed.
danisharora099
added a commit
that referenced
this pull request
Feb 7, 2023
- update changelog - change naming for `EciesEncoderOptions` and `SymmetricEncoderOptions`
|
@fryorcraken addressed the above ^ |
danisharora099
added a commit
that referenced
this pull request
Feb 9, 2023
* address comments from #1145 * fix: typedoc * address comments in #1146 (review) - update changelog - change naming for `EciesEncoderOptions` and `SymmetricEncoderOptions`
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
ref: #1010 (comment)