Function isPrimitive

isPrimitive(value, primitiveType?): value is JsonPrimitive
Primary Overload
PRIMARY

Determine whether value is a primitive value.
Parameters
- value: undefined | JsonValue
- Optional primitiveType: typeof String | typeof Boolean | typeof Number | null
Returns value is JsonPrimitive

Remarks
You can pass String, Boolean, or Number as the primitiveType parameter.

The overloads to isPrimitive help you narrow the type of a value. They also cause isPrimitive to narrow to never if you pass a JsonObject or JsonArray to it.

Label
- Defined in index.ts:188
isPrimitive(value, primitiveType?): value is never
Overload
Parameters
- value: JsonArray | JsonObject
  
  A JSON value.
- Optional primitiveType: typeof String | typeof Boolean | typeof Number | null
  
  A PrimitiveClass or undefined.
Returns value is never

Remarks
Narrows JsonObject and JsonArray to never. While it probably doesn't make typically make sense to pass a value of a type that's not a JsonObject or JsonArray, this overload reflects the reality of the situation.
- Defined in index.ts:150
isPrimitive<J>(value, primitiveType): value is PrimitiveFor<J, JsonValue>
Overload
Narrows any JsonValue to a specific type of primitive based upon the PrimitiveClass passed.

Specified type Narrowed Type

String string

Boolean boolean

Number number

null null
Type Parameters
- J extends undefined | PrimitiveClass = undefined
Parameters
- value: JsonValue
- primitiveType: J
Returns value is PrimitiveFor<J, JsonValue>
- Defined in index.ts:167

Generated using TypeDoc