📄 `serialization`¶

📊 Analysis Summary¶

Metric	Count
🔧 Functions	2

📚 Table of Contents¶

Functions

🛠️ File Location:¶

📂 packages/rule-tester/src/utils/serialization.ts

Functions¶

`isSerializable(val: unknown): boolean`¶

Check if a value is serializable. Functions or objects like RegExp cannot be serialized by JSON.stringify(). Inspired by: https://stackoverflow.com/questions/30579940/reliable-way-to-check-if-objects-is-serializable-in-javascript

Raw JSDoc

/**
 * Check if a value is serializable.
 * Functions or objects like RegExp cannot be serialized by JSON.stringify().
 * Inspired by: https://stackoverflow.com/questions/30579940/reliable-way-to-check-if-objects-is-serializable-in-javascript
 */

Calls:

isSerializablePrimitiveOrPlainObject
Object.hasOwn
isSerializable

Code

export function isSerializable(val: unknown): boolean {
  if (!isSerializablePrimitiveOrPlainObject(val)) {
    return false;
  }
  if (typeof val === 'object') {
    const valAsObj = val as Record<string, unknown>;
    for (const property in valAsObj) {
      if (Object.hasOwn(valAsObj, property)) {
        if (!isSerializablePrimitiveOrPlainObject(valAsObj[property])) {
          return false;
        }
        if (
          typeof valAsObj[property] === 'object' &&
          !isSerializable(valAsObj[property])
        ) {
          return false;
        }
      }
    }
  }
  return true;
}

`isSerializablePrimitiveOrPlainObject(val: unknown): boolean`¶

Check if a value is a primitive or plain object created by the Object constructor.

Raw JSDoc

/**
 * Check if a value is a primitive or plain object created by the Object constructor.
 */

Calls:

Array.isArray

Internal Comments:

// eslint-disable-next-line eqeqeq, @typescript-eslint/internal/eqeq-nullish (x7)

Code

function isSerializablePrimitiveOrPlainObject(val: unknown): boolean {
  return (
    // eslint-disable-next-line eqeqeq, @typescript-eslint/internal/eqeq-nullish
    val === null ||
    typeof val === 'string' ||
    typeof val === 'boolean' ||
    typeof val === 'number' ||
    (typeof val === 'object' && val.constructor === Object) ||
    Array.isArray(val)
  );
}

Generated by Syntax Scribe

📄 serialization¶