Skip to content
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.

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

[@sounisi5011/encrypted-archive] Maybe the compress option should be deprecated #661

Open
sounisi5011 opened this issue Jan 24, 2023 · 0 comments

Comments

@sounisi5011
Copy link
Owner

When first released, @sounisi5011/encrypted-archive was designed for Node.js.
Therefore, the value of the compress option was also designed to be the same as the option in the Node.js zlib module.
However, for @sounisi5011/encrypted-archive to support browsers, Deno and React Native, the value of the compress option would have to be changed.

Possible solutions are either:

  1. Use Node.js compliant compress options at all runtimes for compatibility

    Adopting this plan requires a deep understanding of the behavior of the compression modules provided by each runtime.
    So far we do not even understand the internal workings of the zlib module provided by Node.js (So we wrote a test of compression for all combination).

  2. Use different compress options at each runtime.

    Users can use the compression options they are familiar with.
    However, it is currently not possible to use different type declarations at different runtimes.

  3. Remove the compress option.

    It is the easiest way. However, it is a breaking change.
    It should also continue to support decompression for backward compatibility.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant