JsValue Struct

Creates a number value.

public JsValue(double value)

Parameters

value double

Properties

Name	Description
False	Gets the `false` value.
IsBigInt	Gets whether the value is a BigInt.
IsBoolean	Gets whether the value is a boolean.
IsCallable	Gets whether the value is a function (an object with a [[Call]] internal method).
IsNull	Gets whether the value is `null`.
IsNullOrUndefined	Gets whether the value is `undefined` or `null`.
IsNumber	Gets whether the value is a number.
IsObject	Gets whether the value is an object.
IsString	Gets whether the value is a string.
IsSymbol	Gets whether the value is a symbol.
IsUndefined	Gets whether the value is `undefined`.
Kind	Gets the type of the value.
Null	Gets the `null` value.
True	Gets the `true` value.
Undefined	Gets the `undefined` value.

False

Gets the false value.

public static JsValue False { get; }

Property value

IsBigInt

Gets whether the value is a BigInt.

public bool IsBigInt { get; }

Property value

IsBoolean

Gets whether the value is a boolean.

public bool IsBoolean { get; }

Property value

IsCallable

Gets whether the value is a function (an object with a [[Call]] internal method).

public bool IsCallable { get; }

Property value

IsNull

Gets whether the value is null.

public bool IsNull { get; }

Property value

IsNullOrUndefined

Gets whether the value is undefined or null.

public bool IsNullOrUndefined { get; }

Property value

IsNumber

Gets whether the value is a number.

public bool IsNumber { get; }

Property value

IsObject

Gets whether the value is an object.

public bool IsObject { get; }

Property value

IsString

Gets whether the value is a string.

public bool IsString { get; }

Property value

IsSymbol

Gets whether the value is a symbol.

public bool IsSymbol { get; }

Property value

IsUndefined

Gets whether the value is undefined.

public bool IsUndefined { get; }

Property value

Kind

Gets the type of the value.

public JsValueKind Kind { get; }

Property value

JsValueKind

Null

Gets the null value.

public static JsValue Null { get; }

Property value

True

Gets the true value.

public static JsValue True { get; }

Property value

Undefined

Gets the undefined value.

public static JsValue Undefined { get; }

Property value

Methods

Name	Description
AsBigInt()	Gets the integer of a BigInt value.
AsBoolean()	Gets the boolean of a boolean value.
AsNumber()	Gets the number of a number value.
AsObject()	Gets the object of an object value.
AsString()	Gets the string of a string value.
AsSymbol()	Gets the symbol of a symbol value.
Equals(JsValue)	Compares two values with the SameValue algorithm (https://tc39.es/ecma262/#sec-samevalue).
Equals(object?)	Compares the value with another `JsValue` with the SameValue algorithm.
FromBigInt(BigInteger)	Creates a BigInt value.
FromBoolean(bool)	Creates a boolean value.
FromNumber(double)	Creates a number value.
FromObject(JsObject?)	Creates an object value, or `null` when the object is null.
FromString(string)	Creates a string value.
GetHashCode()	Gets a hash code consistent with SameValue.
ToString()	Returns a representation of the value for debugging; it never runs JavaScript code (use `ToString` of `JsOperations` for the ToString operation).
TryGetBoolean(bool)	Gets the boolean of the value; returns false when the value is not a boolean (no conversion).
TryGetNumber(double)	Gets the number of the value; returns false when the value is not a number (no conversion).
TryGetObject()	Gets the object of the value, or null when the value is not an object.
TryGetString(string?)	Gets the string of the value; returns false when the value is not a string (no conversion).

AsBigInt()

Gets the integer of a BigInt value.

public BigInteger AsBigInt()

Returns

BigInteger

Exceptions

InvalidOperationException: The value is not a BigInt (use JsEngine.ToBigInt to convert it).

AsBoolean()

Gets the boolean of a boolean value.

public bool AsBoolean()

Gets the number of a number value.

public double AsNumber()

Returns

double

Exceptions

InvalidOperationException: The value is not a number (use JsValue.TryGetNumber, or JsEngine.ToNumber to convert it).

AsObject()

Gets the object of an object value.

public JsObject AsObject()

Returns

JsObject

Exceptions

InvalidOperationException: The value is not an object (use JsValue.TryGetObject, or JsEngine.ToObject to convert it).

AsString()

Gets the string of a string value.

public string AsString()

Returns

string

Exceptions

InvalidOperationException: The value is not a string (use JsValue.TryGetString, or JsEngine.ToString to convert it).

AsSymbol()

Gets the symbol of a symbol value.

public JsSymbol AsSymbol()

Returns

JsSymbol

Exceptions

InvalidOperationException: The value is not a symbol.

Equals overloads

Equals(JsValue)

Compares two values with the SameValue algorithm (https://tc39.es/ecma262/#sec-samevalue).

public bool Equals(JsValue other)

Parameters

other JsValue

Returns

Equals(object?)

Compares the value with another JsValue with the SameValue algorithm.

public override bool Equals(object? obj)

Parameters

obj object?

Returns

FromBigInt(BigInteger)

Creates a BigInt value.

public static JsValue FromBigInt(BigInteger value)

Parameters

value BigInteger

Returns

FromBoolean(bool)

Creates a boolean value.

public static JsValue FromBoolean(bool value)

Parameters

value bool

Returns

FromNumber(double)

Creates a number value.

public static JsValue FromNumber(double value)

Parameters

value double

Returns

FromObject(JsObject?)

Creates an object value, or null when the object is null.

public static JsValue FromObject(JsObject? value)

Parameters

value JsObject?

Returns

FromString(string)

Creates a string value.

public static JsValue FromString(string value)

Parameters

value string

Returns

GetHashCode()

Gets a hash code consistent with SameValue.

public override int GetHashCode()

Returns

int

ToString()

Returns a representation of the value for debugging; it never runs JavaScript code (use ToString of JsOperations for the ToString operation).

public override string ToString()

Returns

string

TryGetBoolean(bool)

Gets the boolean of the value; returns false when the value is not a boolean (no conversion).

public bool TryGetBoolean(out bool value)

Parameters

value bool

Returns

TryGetNumber(double)

Gets the number of the value; returns false when the value is not a number (no conversion).

public bool TryGetNumber(out double value)

Parameters

value double

Returns

TryGetObject()

Gets the object of the value, or null when the value is not an object.

public JsObject? TryGetObject()

Returns

JsObject?

TryGetString(string?)

Gets the string of the value; returns false when the value is not a string (no conversion).

public bool TryGetString(out string? value)

Parameters

value string?

Returns

Operators

Name	Description
operator ==(JsValue, JsValue)	Compares two values with the SameValue algorithm.
implicit operator JsValue(JsObject?)	Converts an object to a value (`null` when the object is null).
implicit operator JsValue(JsSymbol)	Converts a symbol to a value.
implicit operator JsValue(bool)	Converts a boolean to a value.
implicit operator JsValue(double)	Converts a number to a value.
implicit operator JsValue(int)	Converts a number to a value.
implicit operator JsValue(string)	Converts a string to a value.
operator !=(JsValue, JsValue)	Compares two values with the SameValue algorithm.

operator ==(JsValue, JsValue)

Compares two values with the SameValue algorithm.

public static bool operator ==(JsValue left, JsValue right)

Parameters

left JsValue
right JsValue

Returns

op_Implicit overloads

implicit operator JsValue(JsObject?)

Converts an object to a value (null when the object is null).

public static implicit operator JsValue(JsObject? value)

Parameters

value JsObject?

Returns

implicit operator JsValue(JsSymbol)

Converts a symbol to a value.

public static implicit operator JsValue(JsSymbol value)

Parameters

value JsSymbol

Returns

implicit operator JsValue(bool)

Converts a boolean to a value.

public static implicit operator JsValue(bool value)

Parameters

value bool

Returns

implicit operator JsValue(double)

Converts a number to a value.

public static implicit operator JsValue(double value)

Parameters

value double

Returns

implicit operator JsValue(int)

Converts a number to a value.

public static implicit operator JsValue(int value)

Parameters

value int

Returns

implicit operator JsValue(string)

Converts a string to a value.

public static implicit operator JsValue(string value)

Parameters

value string

Returns

operator !=(JsValue, JsValue)

Compares two values with the SameValue algorithm.

public static bool operator !=(JsValue left, JsValue right)

Parameters

left JsValue
right JsValue

Returns