size-satisfies

!version
![OpenSSF
Scorecard](https://api.securityscorecards.dev/projects/github.com/NodeSecure/size-satisfies)
!MIT
!size
!build

Same as SemVer.satisfies but for file size!

Requirements

- Node.js v12 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

``bash
$ npm i @nodesecure/size-satisfies


or


$ yarn add @nodesecure/size-satisfies
`

Usage example

`js
import { strict } from "assert";
import sizeSatisfies from "size-satisfies";

const { strictEqual } = strict;

strictEqual(sizeSatisfies(">= 45KB", "20MB"), true);
strictEqual(sizeSatisfies("= 1MB", "1MB"), true);
strictEqual(sizeSatisfies("= 1MB", 2000), false);
`

The first argument of the sizeSatisfies method is the pattern with the operator + size. Available operators are >=, <=, >, <, =`.

API

$3

When the size is a string we convert it to a bytes number. When the argument is a number we consider the value as bytes.

Invalid pattern will always return false.

Contributors ✨


Thanks goes to these wonderful people (emoji key):

Gentilhomme 💻 📖 👀 🛡️ 🐛

Nicolas Hallaert 📖

Tony Gorez 💻 📖 👀

tekeuange23 📖

License

MIT