util-nonempty

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

Table of Contents

• Install
• Purpose
• API
• Contributing
• Licence

Install

npm i util-nonempty

// consume as a CommonJS require:
const nonEmpty = require('util-nonempty')
// or as ES module:
import nonEmpty from 'util-nonempty'

// then call as a function, pass it anything:
console.log(nonEmpty('a'))

Here's what you'll get:

⬆  back to top

Purpose

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

nonEmpty('z')
// => true

nonEmpty('')
// => false

nonEmpty(['a'])
// => true

nonEmpty([123])
// => true

nonEmpty([[[[[[[[[[[]]]]]]]]]]])
// => false

nonEmpty({a: 'a'})
// => true

nonEmpty({})
// => false

var f = function () { return 'z' }
nonEmpty(f)
// => false (answer is instantly false if input is not array, plain object or string)

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 posthtml-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 posthtml-ast-contains-only-empty-space.

⬆  back to top

API

Anything-in, Boolean-out.

Contributing

Hi! 99% of people in the society are passive - consumers. They wait for others to take action, they prefer to blend in. The remaining 1% are proactive citizens who will do something rather than wait. If you are one of that 1%, you're in luck because I am the same and together we can make something happen.

• If you want a new feature in this package or you would like to change some of its functionality, raise an issue on this repo. Also, you can email me. Just let it out.

• If you tried to use this library but it misbehaves, or you need an advice setting it up, and its readme doesn't make sense, just document it and raise an issue on this repo. Alternatively, you can email me.

• If you don't like the code in here and would like to give advice about how something could be done better, please do. Same drill - GitHub issues or email, your choice.

• If you would like to add or change some features, just fork it, hack away, and file a pull request. I'll do my best to merge it quickly. Code style is airbnb-base, only without semicolons. If you use a good code editor, it will pick up the established ESLint setup.

⬆  back to top

Licence

MIT License (MIT)

Copyright © 2018 Codsen Ltd, Roy Revelt