arg-guard
TypeScript icon, indicating that this package has built-in type declarations

3.0.0 • Public • Published

Introduction

This project provides simple guard methods for throwing appropriate type errors when arguments are incorrect.

Variants supported...

  • throwIf() - Throws if the parameter is null or undefined.
  • throwIfNotIn() - Throws if the required parameter is not in the range of expected values.
  • throwIfNull() - Throws if the required parameter is null.
  • throwIfUndefined() - Throws if the parameter is undefined.
  • throwIfNaN() - Throws if the specified parameter is not a number.

Sample usage

const guard = require("arg-guard");

const myFunc = function(requiredArg, otherArg) {
    guard.throwIf(requiredArg, "requiredArg");
}

The Ministry of Technology Open Source Products

Welcome to The Ministry of Technology open source products. All open source Ministry of Technology products are distributed under the MIT License for maximum re-usability. Our other open source repositories can be found here...

Where can I get it?

You can download the package for this project from any of the following package managers...

Contribution guidelines

If you would like to contribute to the project, please contact me.

Who do I talk to?

Readme

Keywords

Package Sidebar

Install

npm i arg-guard

Weekly Downloads

26

Version

3.0.0

License

MIT

Unpacked Size

10.9 kB

Total Files

7

Last publish

Collaborators

  • ministryotech