RaptorJS Utilities

Common errors

• ReferenceError: require is not defined

  cause Attempting to use `require()` in an ECMAScript Module (ESM) context (e.g., in a `.mjs` file or when `"type": "module"` is set in `package.json`).
  fix This package is designed for CommonJS. You either need to run your code in a CommonJS environment or configure a bundler to handle CommonJS modules within an ESM project. Direct ESM `import` statements for `raptor-util` are unlikely to work without extensive build tooling.

• TypeError: Cannot destructure property 'someFunction' of require(...) as it is undefined.

  cause Attempting to import a function that does not exist or has a different name than expected from the `raptor-util` module.
  fix Double-check the exact export names of the utility functions you intend to use. Without official documentation, this may require inspecting the package's source code if you truly need to use it. Many common utility functions have standard names, but this package's specific exports are not publicly documented.

Warnings

• breaking The `raptor-util` package and the broader RaptorJS framework are abandoned. The last activity on the GitHub repository was in 2017, and related npm packages were last published in 2014-2015. It is not maintained and may contain unpatched vulnerabilities or incompatibilities with modern JavaScript runtimes.
  Fix: Avoid using `raptor-util` for new projects. Consider modern, actively maintained utility libraries like Lodash, Ramda, or even native browser/Node.js APIs which have evolved significantly since this package's last update.
• gotcha `raptor-util` was developed primarily for CommonJS environments (Node.js versions prevalent before 2017). Using it in modern ESM-only projects or environments without proper transpilation/bundling can lead to 'require is not defined' errors or other module resolution failures.
  Fix: If absolutely necessary to use in a modern project, configure your bundler (e.g., Webpack, Rollup, Parcel) to handle CommonJS modules or use a CommonJS compatible Node.js environment. For browser usage, ensure it's bundled and polyfilled appropriately.
• gotcha This library does not ship with TypeScript type definitions. Using it in a TypeScript project will require manually creating declaration files (e.g., `raptor-util.d.ts`) to provide type safety and avoid compiler errors.
  Fix: Create a `declarations.d.ts` file or similar in your project with `declare module 'raptor-util';` or more specific declarations for the functions you use. For example: `declare module 'raptor-util' { export function extend(...args: any[]): any; export function isObject(value: any): boolean; export function forEach(collection: any, iteratee: Function): void; }`

Install

• npm install raptor-util npm
• yarn add raptor-util yarn
• pnpm add raptor-util pnpm

Imports

• extend
  wrong:

  import { extend } from 'raptor-util';

  correct:

  const { extend } = require('raptor-util');

  This package primarily targets CommonJS environments. While ES Modules syntax might be attempted, it will likely fail or require bundler/transpiler configuration for compatibility.
• isObject
  wrong:

  const isObject = require('raptor-util').isObject;

  correct:

  const { isObject } = require('raptor-util');

  Named exports are the typical pattern for this library. Attempting to destructure directly from `require` is the idiomatic CommonJS approach.
• forEach
  wrong:

  import forEach from 'raptor-util';

  correct:

  const { forEach } = require('raptor-util');

  There is no default export. Individual utility functions are exported as named members of the module.

Quickstart

This quickstart demonstrates importing `extend`, `isObject`, and `forEach` utilities using CommonJS `require` and showcases their basic usage for object merging, type checking, and iteration.

const { extend, isObject, forEach } = require('raptor-util');

// Example: Extending an object
const obj1 = { a: 1, b: 2 };
const obj2 = { b: 3, c: 4 };
const merged = extend({}, obj1, obj2);
console.log('Extended object:', merged); // Expected: { a: 1, b: 3, c: 4 }

// Example: Checking if a variable is an object
console.log('Is {}:', isObject({})); // Expected: true
console.log('Is null:', isObject(null)); // Expected: false

// Example: Iterating over an array or object
const items = ['apple', 'banana', 'cherry'];
console.log('Iterating over items:');
forEach(items, (item, index) => {
  console.log(`  ${index}: ${item}`);
});

const data = { name: 'Alice', age: 30 };
console.log('Iterating over data:');
forEach(data, (value, key) => {
  console.log(`  ${key}: ${value}`);
});