V8 API Reference Guide for node.js v9.8.0
Public Member Functions | Static Public Member Functions | Static Public Attributes | List of all members
v8::Function Class Reference

#include <v8.h>

Inheritance diagram for v8::Function:
Inheritance graph
[legend]
Collaboration diagram for v8::Function:
Collaboration graph
[legend]

Public Member Functions

 V8_DEPRECATED ("Use maybe version", Local< Object > NewInstance(int argc, Local< Value > argv[]) const)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Object > NewInstance (Local< Context > context, int argc, Local< Value > argv[]) const
 
 V8_DEPRECATED ("Use maybe version", Local< Object > NewInstance() const)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Object > NewInstance (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Call(Local< Value > recv, int argc, Local< Value > argv[]))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > Call (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
void SetName (Local< String > name)
 
Local< Value > GetName () const
 
Local< Value > GetInferredName () const
 
Local< Value > GetDebugName () const
 
Local< Value > GetDisplayName () const
 
int GetScriptLineNumber () const
 
int GetScriptColumnNumber () const
 
 V8_DEPRECATED ("this should no longer be used.", bool IsBuiltin() const)
 
int ScriptId () const
 
Local< Value > GetBoundFunction () const
 
ScriptOrigin GetScriptOrigin () const
 
- Public Member Functions inherited from v8::Object
 V8_DEPRECATE_SOON ("Use maybe version", bool Set(Local< Value > key, Local< Value > value))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Set (Local< Context > context, Local< Value > key, Local< Value > value)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Set(uint32_t index, Local< Value > value))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Set (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)
 
V8_WARN_UNUSED_RESULT Maybe< bool > DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)
 
V8_WARN_UNUSED_RESULT Maybe< bool > DefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)
 
 V8_DEPRECATED ("Use CreateDataProperty / DefineOwnProperty", Maybe< bool > ForceSet(Local< Context > context, Local< Value > key, Local< Value > value, PropertyAttribute attribs=None))
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Get(Local< Value > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > Get (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Value > Get(uint32_t index))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > Get (Local< Context > context, uint32_t index)
 
 V8_DEPRECATED ("Use maybe version", PropertyAttribute GetPropertyAttributes(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetPropertyAttributes (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATED ("Use maybe version", Local< Value > GetOwnPropertyDescriptor(Local< Name > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > GetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Has(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Has (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Delete(Local< Value > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Delete (Local< Context > context, Local< Value > key)
 
 V8_DEPRECATED ("Use maybe version", bool Has(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Has (Local< Context > context, uint32_t index)
 
 V8_DEPRECATED ("Use maybe version", bool Delete(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< bool > Delete (Local< Context > context, uint32_t index)
 
 V8_DEPRECATED ("Use maybe version", bool SetAccessor(Local< String > name, AccessorGetterCallback getter, AccessorSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None))
 
 V8_DEPRECATED ("Use maybe version", bool SetAccessor(Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, Local< Value > data=Local< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None))
 
V8_WARN_UNUSED_RESULT Maybe< bool > SetAccessor (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=0, MaybeLocal< Value > data=MaybeLocal< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None)
 
void SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
V8_WARN_UNUSED_RESULT Maybe< bool > SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None)
 
Maybe< bool > HasPrivate (Local< Context > context, Local< Private > key)
 
Maybe< bool > SetPrivate (Local< Context > context, Local< Private > key, Local< Value > value)
 
Maybe< bool > DeletePrivate (Local< Context > context, Local< Private > key)
 
MaybeLocal< Value > GetPrivate (Local< Context > context, Local< Private > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< Array > GetPropertyNames (Local< Context > context)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Array > GetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Array > GetOwnPropertyNames())
 
V8_WARN_UNUSED_RESULT MaybeLocal< Array > GetOwnPropertyNames (Local< Context > context)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Array > GetOwnPropertyNames (Local< Context > context, PropertyFilter filter)
 
Local< Value > GetPrototype ()
 
 V8_DEPRECATED ("Use maybe version", bool SetPrototype(Local< Value > prototype))
 
V8_WARN_UNUSED_RESULT Maybe< bool > SetPrototype (Local< Context > context, Local< Value > prototype)
 
Local< Object > FindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)
 
 V8_DEPRECATED ("Use maybe version", Local< String > ObjectProtoToString())
 
V8_WARN_UNUSED_RESULT MaybeLocal< String > ObjectProtoToString (Local< Context > context)
 
Local< String > GetConstructorName ()
 
Maybe< bool > SetIntegrityLevel (Local< Context > context, IntegrityLevel level)
 
int InternalFieldCount ()
 
V8_INLINE Local< Value > GetInternalField (int index)
 
void SetInternalField (int index, Local< Value > value)
 
V8_INLINE void * GetAlignedPointerFromInternalField (int index)
 
void SetAlignedPointerInInternalField (int index, void *value)
 
void SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])
 
 V8_DEPRECATED ("Use maybe version", bool HasOwnProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasOwnProperty (Local< Context > context, Local< Name > key)
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasOwnProperty (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealNamedProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealIndexedProperty(uint32_t index))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealIndexedProperty (Local< Context > context, uint32_t index)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool HasRealNamedCallbackProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< bool > HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATED ("Use maybe version", Local< Value > GetRealNamedPropertyInPrototypeChain(Local< String > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > GetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATED ("Use maybe version", Maybe< PropertyAttribute > GetRealNamedPropertyAttributesInPrototypeChain(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATED ("Use maybe version", Local< Value > GetRealNamedProperty(Local< String > key))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > GetRealNamedProperty (Local< Context > context, Local< Name > key)
 
 V8_DEPRECATED ("Use maybe version", Maybe< PropertyAttribute > GetRealNamedPropertyAttributes(Local< String > key))
 
V8_WARN_UNUSED_RESULT Maybe< PropertyAttribute > GetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)
 
bool HasNamedLookupInterceptor ()
 
bool HasIndexedLookupInterceptor ()
 
int GetIdentityHash ()
 
Local< Object > Clone ()
 
Local< Context > CreationContext ()
 
bool IsCallable ()
 
bool IsConstructor ()
 
 V8_DEPRECATED ("Use maybe version", Local< Value > CallAsFunction(Local< Value > recv, int argc, Local< Value > argv[]))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > CallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
 V8_DEPRECATED ("Use maybe version", Local< Value > CallAsConstructor(int argc, Local< Value > argv[]))
 
V8_WARN_UNUSED_RESULT MaybeLocal< Value > CallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])
 
 V8_DEPRECATE_SOON ("Keep track of isolate correctly", Isolate *GetIsolate())
 
- Public Member Functions inherited from v8::Value
V8_INLINE bool IsUndefined () const
 
V8_INLINE bool IsNull () const
 
V8_INLINE bool IsNullOrUndefined () const
 
bool IsTrue () const
 
bool IsFalse () const
 
bool IsName () const
 
V8_INLINE bool IsString () const
 
bool IsSymbol () const
 
bool IsFunction () const
 
bool IsArray () const
 
bool IsObject () const
 
bool IsBoolean () const
 
bool IsNumber () const
 
bool IsExternal () const
 
bool IsInt32 () const
 
bool IsUint32 () const
 
bool IsDate () const
 
bool IsArgumentsObject () const
 
bool IsBooleanObject () const
 
bool IsNumberObject () const
 
bool IsStringObject () const
 
bool IsSymbolObject () const
 
bool IsNativeError () const
 
bool IsRegExp () const
 
bool IsAsyncFunction () const
 
bool IsGeneratorFunction () const
 
bool IsGeneratorObject () const
 
bool IsPromise () const
 
bool IsMap () const
 
bool IsSet () const
 
bool IsMapIterator () const
 
bool IsSetIterator () const
 
bool IsWeakMap () const
 
bool IsWeakSet () const
 
bool IsArrayBuffer () const
 
bool IsArrayBufferView () const
 
bool IsTypedArray () const
 
bool IsUint8Array () const
 
bool IsUint8ClampedArray () const
 
bool IsInt8Array () const
 
bool IsUint16Array () const
 
bool IsInt16Array () const
 
bool IsUint32Array () const
 
bool IsInt32Array () const
 
bool IsFloat32Array () const
 
bool IsFloat64Array () const
 
bool IsDataView () const
 
bool IsSharedArrayBuffer () const
 
bool IsProxy () const
 
bool IsWebAssemblyCompiledModule () const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Boolean > ToBoolean (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Number > ToNumber (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< String > ToString (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< String > ToDetailString (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Object > ToObject (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Integer > ToInteger (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32 > ToUint32 (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT MaybeLocal< Int32 > ToInt32 (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Boolean > ToBoolean(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Number > ToNumber(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString(Isolate *isolate) const)
 
 V8_DEPRECATED ("Use maybe version", Local< String > ToDetailString(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger(Isolate *isolate) const)
 
 V8_DEPRECATED ("Use maybe version", Local< Uint32 > ToUint32(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Int32 > ToInt32(Isolate *isolate) const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Boolean > ToBoolean() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Number > ToNumber() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< String > ToString() const)
 
 V8_DEPRECATED ("Use maybe version", Local< String > ToDetailString() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Object > ToObject() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", Local< Integer > ToInteger() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Uint32 > ToUint32() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Int32 > ToInt32() const)
 
 V8_DEPRECATED ("Use maybe version", Local< Uint32 > ToArrayIndex() const)
 
V8_WARN_UNUSED_RESULT MaybeLocal< Uint32 > ToArrayIndex (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< bool > BooleanValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< double > NumberValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< int64_t > IntegerValue (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< uint32_t > Uint32Value (Local< Context > context) const
 
V8_WARN_UNUSED_RESULT Maybe< int32_t > Int32Value (Local< Context > context) const
 
 V8_DEPRECATE_SOON ("Use maybe version", bool BooleanValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", double NumberValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", int64_t IntegerValue() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", uint32_t Uint32Value() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", int32_t Int32Value() const)
 
 V8_DEPRECATE_SOON ("Use maybe version", bool Equals(Local< Value > that) const)
 
V8_WARN_UNUSED_RESULT Maybe< bool > Equals (Local< Context > context, Local< Value > that) const
 
bool StrictEquals (Local< Value > that) const
 
bool SameValue (Local< Value > that) const
 
Local< String > TypeOf (Isolate *)
 
Maybe< bool > InstanceOf (Local< Context > context, Local< Object > object)
 
template<class T >
Value * Cast (T *value)
 

Static Public Member Functions

static MaybeLocal< Function > New (Local< Context > context, FunctionCallback callback, Local< Value > data=Local< Value >(), int length=0, ConstructorBehavior behavior=ConstructorBehavior::kAllow)
 
static V8_DEPRECATE_SOON ("Use maybe version", Local< Function > New(Isolate *isolate, FunctionCallback callback, Local< Value > data=Local< Value >(), int length=0))
 
static V8_INLINE Function * Cast (Value *obj)
 
- Static Public Member Functions inherited from v8::Object
static V8_INLINE int InternalFieldCount (const PersistentBase< Object > &object)
 
static V8_INLINE void * GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)
 
static V8_INLINE Local< Context > CreationContext (const PersistentBase< Object > &object)
 
static Local< Object > New (Isolate *isolate)
 
static V8_INLINE Object * Cast (Value *obj)
 
- Static Public Member Functions inherited from v8::Value
template<class T >
static V8_INLINE Value * Cast (T *value)
 

Static Public Attributes

static const int kLineOffsetNotFound
 

Detailed Description

A JavaScript function object (ECMA-262, 15.3).

Member Function Documentation

Local<Value> v8::Function::GetBoundFunction ( ) const

Returns the original function if this function is bound, else returns v8::Undefined.

Local<Value> v8::Function::GetDebugName ( ) const

displayName if it is set, otherwise name if it is configured, otherwise function name, otherwise inferred name.

Local<Value> v8::Function::GetDisplayName ( ) const

User-defined name assigned to the "displayName" property of this function. Used to facilitate debugging and profiling of JavaScript code.

Local<Value> v8::Function::GetInferredName ( ) const

Name inferred from variable or property assignment of this function. Used to facilitate debugging and profiling of JavaScript code written in an OO style, where many functions are anonymous but are assigned to object properties.

int v8::Function::GetScriptColumnNumber ( ) const

Returns zero based column number of function body and kLineOffsetNotFound if no information available.

int v8::Function::GetScriptLineNumber ( ) const

Returns zero based line number of function body and kLineOffsetNotFound if no information available.

static MaybeLocal<Function> v8::Function::New ( Local< Context >  context,
FunctionCallback  callback,
Local< Value >  data = Local< Value >(),
int  length = 0,
ConstructorBehavior  behavior = ConstructorBehavior::kAllow 
)
static

Create a function in the current execution context for a given FunctionCallback.

int v8::Function::ScriptId ( ) const

Returns scriptId.

v8::Function::V8_DEPRECATED ( "this should no longer be used."  ,
bool IsBuiltin()  const 
)

Tells whether this function is builtin.

The documentation for this class was generated from the following file:
Generated by   doxygen 1.8.11