Is JSON (ES)

⚖️ MIT

🔗 DistBoard @hugoalh ● GitHub ● JSR ● NPM

An ECMAScript module to determine whether the item is a JSON.

🎯 Runtime Targets

Any runtime which support ECMAScript should able to use this; These runtimes are officially supported:

• Bun >= v1.1.0
• Deno >= v2.1.0
• NodeJS >= v20.9.0

🛡️ Runtime Permissions

This does not request any runtime permission.

#️⃣ Sources & Entrypoints

• GitHub Raw

  https://raw.githubusercontent.com/hugoalh/is-json-es/{Tag}/mod.ts

• JSR

  jsr:@hugoalh/is-json[@{Tag}]

• NPM

  npm:@hugoalh/is-json[@{Tag}]

| Name | Path | Description | |:--|:--|:--| | . | ./mod.ts | Default. |

[!NOTE]

• Different runtimes have vary support for the sources and entrypoints, visit the runtime documentation for more information.
• It is recommended to include tag for immutability.
• These are not part of the public APIs hence should not be used:
  • Benchmark/Test file (e.g.: example.bench.ts, example.test.ts).
  • Entrypoint name or path include any underscore prefix (e.g.: _example.ts, foo/_example.ts).
  • Identifier/Namespace/Symbol include any underscore prefix (e.g.: _example, Foo._example).

🧩 APIs

• function isJSON(item: unknown): item is JSONValue;

• function isJSONArray(item: unknown): item is JSONArray;

• function isJSONObject(item: unknown): item is JSONObject;

• function isJSONPrimitive(item: unknown): item is JSONPrimitive;

[!NOTE]

• For the full or prettier documentation, can visit via:
  • Deno CLI deno doc
  • JSR

✍️ Examples

• isJSON({
    a: 1,
    b: 2,
    c: 3,
    d: () => { }
  });
  //=> false

• isJSON({
    a: 1,
    b: 2,
    c: 3,
    d: new Map()
  });
  //=> false

• isJSON(NaN);
  //=> false

• isJSON(void 0);
  //=> false

• isJSON({
    a: 1,
    b: 2,
    c: 3
  });
  //=> true

• isJSON([1, 2, 3]);
  //=> true