@nodesecure/size-satisfies
TypeScript icon, indicating that this package has built-in type declarations

1.1.0 • Public • Published

size-satisfies

version OpenSSF Scorecard MIT size build

Same as SemVer.satisfies but for file size!

Requirements

Getting Started

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

$ npm i @nodesecure/size-satisfies
# or
$ yarn add @nodesecure/size-satisfies

Usage example

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

sizeSatisfies(pattern: string, size: number | string): boolean

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

All Contributors

Thanks goes to these wonderful people (emoji key):


Gentilhomme

💻 📖 👀 🛡️ 🐛

Nicolas Hallaert

📖

Tony Gorez

💻 📖 👀

tekeuange23

📖

License

MIT

Package Sidebar

Install

npm i @nodesecure/size-satisfies

Weekly Downloads

0

Version

1.1.0

License

MIT

Unpacked Size

7.6 kB

Total Files

5

Last publish

Collaborators

  • pierred
  • antoine-coulon
  • kawacrepe
  • fraxken
  • tonygo