util-nonempty^2.10.0

Is the input (plain object, array, string or whatever) not empty?

Install via npm

npm i util-nonempty

The default is exported, so instead of nonEmpty below, you can name the consumed function however you want.

Consume via a require():

const nonEmpty = require("util-nonempty");

or as an ES Module:

import nonEmpty from "util-nonempty";

Install as a script, via CDN

Put this in your HTML:

<script src="https://cdn.jsdelivr.net/npm/util-nonempty/dist/util-nonempty.umd.js">

Then, you’ll get a global variable utilNonempty in your Global object and you consume it like this:

const nonEmpty = utilNonempty;

This nonEmpty is your main function. See its API in the main section.

Trivia

This program has 17 assertions in its unit tests. That's less than all unit test assertions' median (50) and less than geometric mean (70).

In monorepo, one other package, object-merge-advanced, consumes this package.

§ Quick Take

import { strict as assert } from "assert";
import nonEmpty from "util-nonempty";

assert.equal(nonEmpty("z"), true);
assert.equal(nonEmpty(""), false);
assert.equal(nonEmpty(["a"]), true);
assert.equal(nonEmpty([123]), true);
assert.equal(nonEmpty([[[[[[[[[[[]]]]]]]]]]]), true);
assert.equal(nonEmpty({ a: "" }), true);
assert.equal(nonEmpty({ a: "a" }), true);
assert.equal(nonEmpty({}), false);

const f = () => {
  return "z";
};
assert.equal(nonEmpty(f), false);
// (answer is instantly false if input is not array, plain object or string)

⬆ back to top

§ Purpose

It is a quick utility function, to be able to detect is the input not empty.

If you want to check non-emptiness of complex nested trees of objects, arrays and strings (like parsed HTML AST), you need a library which can recursively traverse that. There are two options:

If you want to check for strict emptiness, that is [] or {} is empty, but {aaa: ' \n\n\n ', ' \t'} is not, see ast-is-empty
If your "emptiness" definition is "everything that String.trim()'s to an empty string'" (this includes tabs, spaces and line breaks for example, but not letters), see ast-contains-only-empty-space, or plain objects without keys or zero-length arrays.

⬆ back to top