Skip to content

Commit

Permalink
docs: allow zlib option in typings
Browse files Browse the repository at this point in the history
  • Loading branch information
antongolub committed Oct 28, 2023
1 parent 36ff237 commit 1d22e9e
Show file tree
Hide file tree
Showing 2 changed files with 3 additions and 1 deletion.
3 changes: 2 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,7 @@ npm registry proxy with on-the-fly filtering
* Standalone. No clouds, no subscriptions.
* Linux / Windows / macOS compatible.
* Works with [Bun](https://github.com/Jarred-Sumner/bun). But `config.zlib:` [fflate](https://github.com/101arrowz/fflate) does not work because: `worker_threads.Worker option "eval" is not implemented.`
* Has no deps. Literally zero.
* Has no prod deps. Literally zero.

## Motivation

Expand Down Expand Up @@ -249,6 +249,7 @@ type TFirewallConfig = Record<string, TFirewallConfigEntry>
type TConfig = {
server: TServerConfig
firewall: TFirewallConfig
zlib?: string // ref to zlib implementation like `fflate`. Defaults to `node:zlib`
extend?: string
agent?: TAgentConfig
log?: { level?: TLogeLevel }
Expand Down
1 change: 1 addition & 0 deletions src/main/js/index.d.ts
Original file line number Diff line number Diff line change
Expand Up @@ -77,6 +77,7 @@ type TFirewallConfig = Record<string, TFirewallConfigEntry>
type TConfig = {
server: TServerConfig
firewall: TFirewallConfig
zlib?: string // ref to zlib implementation like `fflate`. Defaults to `node:zlib`
extend?: string
agent?: TAgentConfig
log?: { level?: TLogeLevel }
Expand Down

0 comments on commit 1d22e9e

Please sign in to comment.