Skip to main content

isJsonObject() function

Determines whether a value is a JSON object.

Signature

export declare function isJsonObject(value: unknown): boolean;

Parameters

Parameter

Type

Description

value

unknown

The value to test.

Returns

boolean

true if the value is a JSON object, false otherwise.

Remarks

Validates that a value represents a JSON object, which is stricter than JavaScript's general object type. This is essential when working with parsed JSON data or package.json structures.

Returns true for: plain objects (non-null, non-primitive, non-array values).

Returns false for: undefined, null, primitives (string, number, boolean, etc.), and arrays.

This is the primary validation function for JSON objects in the xpm codebase, used extensively when parsing package.json sections like xpack.properties, xpack.buildConfigurations, etc.


Generated via tsdoc2docusaurus 1.3.0-pre by API Extractor/Documenter 7.55.2.