Jerryscript Namespace Reference

Namespaces
	Snapshot
	Snapshot management functions.
	Watchdog

Classes
class	Context
	Jerryscript external context. More...
class	ContextTemplate
	Implement a custom Context class. More...
class	ContextList
	Manages a list of contexts. More...
class	Except
struct	CallInfo
	Maps directly onto jerry_call_info_t structure. More...
class	Task
	Task that runs the loop JavaScript function in the background More...
struct	OwnedValue
	Use to initialise Value object by taking ownership of native/raw jerryscript value. More...
struct	CopyValue
	Use to initialise Value object by copying native/raw jerryscript value. More...
struct	StringValue
	Use to initialise Value object to a string given a native/raw jerryscript value. More...
struct	Undefined
	Use to create Value containing javascript 'undefined'. More...
struct	Null
	Use to create Value containing javascript 'null'. More...
class	Value
	Represents a Jerryscript value. More...
class	ExternalFunction
	Object representing an external function implementation. More...
class	Object
	Objects support named properties. More...
class	Error
	Error object class. More...
class	ArgumentError
	Provides consistent error message when checking external function arguments. More...
class	Array
	Array objects have properties accessed by index. More...
class	Callable
	Callable object represent functions. More...

Typedefs
using	HeapStats = jerry_heap_stats_t

Enumerations
enum class	FatalCode { XX }
enum class	Type { XX }
enum class	ErrorType { XX }
enum class	ObjectType { XX }
enum class	FunctionType { XX }
enum class	Feature { XX }
enum class	Ecma { XX }

Functions
bool	getHeapStats (HeapStats &stats)
size_t	getHeapUsed ()
bool	printHeap ()
jerry_value_t	create_arg_count_error (const char *functionName)
Object	global ()
	Get global context. More...
void	initialise (jerry_init_flag_t flags=JERRY_INIT_EMPTY)
	Initializes the JavaScript VM. More...
void	cleanup ()
	Clean up the virtual machine by unloading snapshots, freeing allocated memory, etc. More...
bool	isFeatureEnabled (Feature feature)
	Check if optional feature is available. More...
Value	eval (const String &jsCode)
void	gc (bool maximumEffort=false)
	Perform memory garbage collection. More...

Typedef Documentation

HeapStats

using Jerryscript::HeapStats = typedef jerry_heap_stats_t

Enumeration Type Documentation

Ecma

enum Jerryscript::Ecma

strong

Enumerator
XX

ErrorType

enum Jerryscript::ErrorType

strong

Enumerator
XX

FatalCode

enum Jerryscript::FatalCode

strong

Enumerator
XX

Feature

enum Jerryscript::Feature

strong

Enumerator
XX

FunctionType

enum Jerryscript::FunctionType

strong

Enumerator
XX

ObjectType

enum Jerryscript::ObjectType

strong

Enumerator
XX

Type

enum Jerryscript::Type

strong

Enumerator
XX

Function Documentation

cleanup()

void Jerryscript::cleanup

(

)

Clean up the virtual machine by unloading snapshots, freeing allocated memory, etc.

Note that this does not release Jerryscript heap memory allocated to existing values. This is done via Value destructor or by manually calling Value::reset().

create_arg_count_error()

jerry_value_t Jerryscript::create_arg_count_error

(

const char *

functionName

)

eval()

Value Jerryscript::eval

(

const String &

jsCode

)

gc()

void Jerryscript::gc ( bool  maximumEffort = false )

inline

Perform memory garbage collection.

getHeapStats()

bool Jerryscript::getHeapStats ( HeapStats &  stats )

inline

getHeapUsed()

size_t Jerryscript::getHeapUsed

(

)

global()

Object Jerryscript::global ( )

inline

Get global context.

initialise()

void Jerryscript::initialise

(

jerry_init_flag_t

flags = JERRY_INIT_EMPTY

)

Initializes the JavaScript VM.

isFeatureEnabled()

bool Jerryscript::isFeatureEnabled ( Feature  feature )

inline

Check if optional feature is available.

Parameters

feature

Return values

bool	true if library has been compiled with requested feature

printHeap()

bool Jerryscript::printHeap

(

)