kylefarris / clamscan

A robust ClamAV virus scanning library supporting scanning files, directories, and streams with local sockets, local/remote TCP, and local clamscan/clamdscan binaries (with failover).

MIT License

236 stars 69 forks source link

v2.0.0 #74

Closed kylefarris closed 3 years ago

kylefarris commented 3 years ago

v2.0.0

This is largely a code-quality / developer-centric overhaul.

Breaking Changes

Node v12+ is now required.
Methods names have changed from snake_case to camelCase
All variable and object properties have changed from snake_case to camelCase

General Changes

All code now has proper JSDoc documentation
New API doc is generated via JSDoc
More strictly-defined code formatting via Prettier and ESLint
Husky now runs linting on commit and runs tests on push.
NodeClamError is now its own file residing in /lib
NodeClamTransform is now located in /lib

New Features

Type-hinting should now work because of JSDoc