@zerodep/guard-pojo

A run-time guard to require a value to be a POJO (plain old javascript object); it will throw a ZeroDepError if the guard fails.

Full documentation is available at the zerodep.app page.

Examples

All @zerodep packages support both ESM and CJS.

import { guardPojo } from '@zerodep/guard-pojo';
// or
const { guardPojo } = require('@zerodep/guard-pojo');

Successful Cases

guardPojo({ an: 'object' }); // void

Unsuccessful Cases

guardPojo([]); // throws ZeroDepError: Value is not a JSON object
guardPojo(['a', 'b', 'c']); // throws ZeroDepError: Value is not a JSON object
guardPojo(1000n); // throws ZeroDepError: Value is not a JSON object
guardPojo(true); // throws ZeroDepError: Value is not a JSON object
guardPojo(new Date()); // throws ZeroDepError: Value is not a JSON object
guardPojo(''); // throws ZeroDepError: Value is not a JSON object
guardPojo(new Error('message')); // throws ZeroDepError: Value is not a JSON object
guardPojo(3.14); // throws ZeroDepError: Value is not a JSON object
guardPojo(() => 'function'); // throws ZeroDepError: Value is not a JSON object
guardPojo(42); // throws ZeroDepError: Value is not a JSON object
guardPojo(
  new Map([
    ['a', 1],
    ['b', 2],
  ])
); // throws ZeroDepError: Value is not a JSON object
guardPojo(null); // throws ZeroDepError: Value is not a JSON object
guardPojo(new Promise(() => {})); // throws ZeroDepError: Value is not a JSON object
guardPojo(/[regex]+/gi); // throws ZeroDepError: Value is not a JSON object
guardPojo(new Set([1, 2, 3])); // throws ZeroDepError: Value is not a JSON object
guardPojo('a string'); // throws ZeroDepError: Value is not a JSON object
guardPojo(Symbol()); // throws ZeroDepError: Value is not a JSON object
guardPojo(new Int32Array(2)); // throws ZeroDepError: Value is not a JSON object
guardPojo(undefined); // throws ZeroDepError: Value is not a JSON object