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:
[legend]
Collaboration diagram for v8::Function:
[legend]

Public Member Functions

MaybeLocal< ObjectNewInstance (Local< Context > context, int argc, Local< Value > argv[]) const
 
MaybeLocal< ObjectNewInstance (Local< Context > context) const
 
MaybeLocal< ObjectNewInstanceWithSideEffectType (Local< Context > context, int argc, Local< Value > argv[], SideEffectType side_effect_type=SideEffectType::kHasSideEffect) const
 
MaybeLocal< ValueCall (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
void SetName (Local< String > name)
 
Local< ValueGetName () const
 
Local< ValueGetInferredName () const
 
Local< ValueGetDebugName () const
 
Local< ValueGetDisplayName () const
 
int GetScriptLineNumber () const
 
int GetScriptColumnNumber () const
 
int ScriptId () const
 
Local< ValueGetBoundFunction () const
 
MaybeLocal< StringFunctionProtoToString (Local< Context > context)
 
ScriptOrigin GetScriptOrigin () const
 
- Public Member Functions inherited from v8::Object
Maybe< bool > Set (Local< Context > context, Local< Value > key, Local< Value > value)
 
Maybe< bool > Set (Local< Context > context, uint32_t index, Local< Value > value)
 
Maybe< bool > CreateDataProperty (Local< Context > context, Local< Name > key, Local< Value > value)
 
Maybe< bool > CreateDataProperty (Local< Context > context, uint32_t index, Local< Value > value)
 
Maybe< bool > DefineOwnProperty (Local< Context > context, Local< Name > key, Local< Value > value, PropertyAttribute attributes=None)
 
Maybe< bool > DefineProperty (Local< Context > context, Local< Name > key, PropertyDescriptor &descriptor)
 
MaybeLocal< ValueGet (Local< Context > context, Local< Value > key)
 
MaybeLocal< ValueGet (Local< Context > context, uint32_t index)
 
Maybe< PropertyAttributeGetPropertyAttributes (Local< Context > context, Local< Value > key)
 
MaybeLocal< ValueGetOwnPropertyDescriptor (Local< Context > context, Local< Name > key)
 
Maybe< bool > Has (Local< Context > context, Local< Value > key)
 
Maybe< bool > Delete (Local< Context > context, Local< Value > key)
 
Maybe< bool > Has (Local< Context > context, uint32_t index)
 
Maybe< bool > Delete (Local< Context > context, uint32_t index)
 
Maybe< bool > SetAccessor (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, MaybeLocal< Value > data=MaybeLocal< Value >(), AccessControl settings=DEFAULT, PropertyAttribute attribute=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
 
void SetAccessorProperty (Local< Name > name, Local< Function > getter, Local< Function > setter=Local< Function >(), PropertyAttribute attribute=None, AccessControl settings=DEFAULT)
 
Maybe< bool > SetNativeDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, AccessorNameSetterCallback setter=nullptr, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
 
Maybe< bool > SetLazyDataProperty (Local< Context > context, Local< Name > name, AccessorNameGetterCallback getter, Local< Value > data=Local< Value >(), PropertyAttribute attributes=None, SideEffectType getter_side_effect_type=SideEffectType::kHasSideEffect, SideEffectType setter_side_effect_type=SideEffectType::kHasSideEffect)
 
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< ValueGetPrivate (Local< Context > context, Local< Private > key)
 
MaybeLocal< ArrayGetPropertyNames (Local< Context > context)
 
MaybeLocal< ArrayGetPropertyNames (Local< Context > context, KeyCollectionMode mode, PropertyFilter property_filter, IndexFilter index_filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)
 
MaybeLocal< ArrayGetOwnPropertyNames (Local< Context > context)
 
MaybeLocal< ArrayGetOwnPropertyNames (Local< Context > context, PropertyFilter filter, KeyConversionMode key_conversion=KeyConversionMode::kKeepNumbers)
 
Local< ValueGetPrototype ()
 
Maybe< bool > SetPrototype (Local< Context > context, Local< Value > prototype)
 
Local< ObjectFindInstanceInPrototypeChain (Local< FunctionTemplate > tmpl)
 
MaybeLocal< StringObjectProtoToString (Local< Context > context)
 
Local< StringGetConstructorName ()
 
Maybe< bool > SetIntegrityLevel (Local< Context > context, IntegrityLevel level)
 
int InternalFieldCount ()
 
Local< ValueGetInternalField (int index)
 
void SetInternalField (int index, Local< Value > value)
 
void * GetAlignedPointerFromInternalField (int index)
 
void SetAlignedPointerInInternalField (int index, void *value)
 
void SetAlignedPointerInInternalFields (int argc, int indices[], void *values[])
 
Maybe< bool > HasOwnProperty (Local< Context > context, Local< Name > key)
 
Maybe< bool > HasOwnProperty (Local< Context > context, uint32_t index)
 
Maybe< bool > HasRealNamedProperty (Local< Context > context, Local< Name > key)
 
Maybe< bool > HasRealIndexedProperty (Local< Context > context, uint32_t index)
 
Maybe< bool > HasRealNamedCallbackProperty (Local< Context > context, Local< Name > key)
 
MaybeLocal< ValueGetRealNamedPropertyInPrototypeChain (Local< Context > context, Local< Name > key)
 
Maybe< PropertyAttributeGetRealNamedPropertyAttributesInPrototypeChain (Local< Context > context, Local< Name > key)
 
MaybeLocal< ValueGetRealNamedProperty (Local< Context > context, Local< Name > key)
 
Maybe< PropertyAttributeGetRealNamedPropertyAttributes (Local< Context > context, Local< Name > key)
 
bool HasNamedLookupInterceptor ()
 
bool HasIndexedLookupInterceptor ()
 
int GetIdentityHash ()
 
Local< ObjectClone ()
 
Local< ContextCreationContext ()
 
bool IsCallable ()
 
bool IsConstructor ()
 
bool IsApiWrapper ()
 
bool IsUndetectable ()
 
MaybeLocal< ValueCallAsFunction (Local< Context > context, Local< Value > recv, int argc, Local< Value > argv[])
 
MaybeLocal< ValueCallAsConstructor (Local< Context > context, int argc, Local< Value > argv[])
 
IsolateGetIsolate ()
 
MaybeLocal< ArrayPreviewEntries (bool *is_key_value)
 
bool IsCodeLike (Isolate *isolate)
 
- Public Member Functions inherited from v8::Value
bool IsUndefined () const
 
bool IsNull () const
 
bool IsNullOrUndefined () const
 
bool IsTrue () const
 
bool IsFalse () const
 
bool IsName () const
 
bool IsString () const
 
bool IsSymbol () const
 
bool IsFunction () const
 
bool IsArray () const
 
bool IsObject () const
 
bool IsBigInt () const
 
bool IsBoolean () const
 
bool IsNumber () const
 
bool IsExternal () const
 
bool IsInt32 () const
 
bool IsUint32 () const
 
bool IsDate () const
 
bool IsArgumentsObject () const
 
bool IsBigIntObject () 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 IsBigInt64Array () const
 
bool IsBigUint64Array () const
 
bool IsDataView () const
 
bool IsSharedArrayBuffer () const
 
bool IsProxy () const
 
bool IsWasmMemoryObject () const
 
bool IsWasmModuleObject () const
 
bool IsModuleNamespaceObject () const
 
MaybeLocal< BigIntToBigInt (Local< Context > context) const
 
MaybeLocal< NumberToNumber (Local< Context > context) const
 
MaybeLocal< StringToString (Local< Context > context) const
 
MaybeLocal< StringToDetailString (Local< Context > context) const
 
MaybeLocal< ObjectToObject (Local< Context > context) const
 
MaybeLocal< IntegerToInteger (Local< Context > context) const
 
MaybeLocal< Uint32ToUint32 (Local< Context > context) const
 
MaybeLocal< Int32ToInt32 (Local< Context > context) const
 
Local< BooleanToBoolean (Isolate *isolate) const
 
MaybeLocal< Uint32ToArrayIndex (Local< Context > context) const
 
bool BooleanValue (Isolate *isolate) const
 
Maybe< double > NumberValue (Local< Context > context) const
 
Maybe< int64_t > IntegerValue (Local< Context > context) const
 
Maybe< uint32_t > Uint32Value (Local< Context > context) const
 
Maybe< int32_t > Int32Value (Local< Context > context) const
 
Maybe< bool > Equals (Local< Context > context, Local< Value > that) const
 
bool StrictEquals (Local< Value > that) const
 
bool SameValue (Local< Value > that) const
 
Local< StringTypeOf (Isolate *)
 
Maybe< bool > InstanceOf (Local< Context > context, Local< Object > object)
 
template<>
ValueCast (Data *value)
 
- Public Member Functions inherited from v8::Data
bool IsValue () const
 
bool IsModule () const
 
bool IsPrivate () const
 
bool IsObjectTemplate () const
 
bool IsFunctionTemplate () const
 
bool IsContext () const
 

Static Public Member Functions

static MaybeLocal< FunctionNew (Local< Context > context, FunctionCallback callback, Local< Value > data=Local< Value >(), int length=0, ConstructorBehavior behavior=ConstructorBehavior::kAllow, SideEffectType side_effect_type=SideEffectType::kHasSideEffect)
 
static FunctionCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Object
static int InternalFieldCount (const PersistentBase< Object > &object)
 
static int InternalFieldCount (const BasicTracedReference< Object > &object)
 
static void * GetAlignedPointerFromInternalField (const PersistentBase< Object > &object, int index)
 
static void * GetAlignedPointerFromInternalField (const BasicTracedReference< Object > &object, int index)
 
static Local< ContextCreationContext (const PersistentBase< Object > &object)
 
static Local< ObjectNew (Isolate *isolate)
 
static Local< ObjectNew (Isolate *isolate, Local< Value > prototype_or_null, Local< Name > *names, Local< Value > *values, size_t length)
 
static ObjectCast (Value *obj)
 
- Static Public Member Functions inherited from v8::Value
template<class T >
static ValueCast (T *value)
 

Static Public Attributes

static const int kLineOffsetNotFound
 

Detailed Description

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

Examples
process.cc.

Member Function Documentation

◆ Call()

MaybeLocal<Value> v8::Function::Call ( Local< Context context,
Local< Value recv,
int  argc,
Local< Value argv[] 
)

◆ Cast()

Function * v8::Function::Cast ( v8::Value value)
inlinestatic

◆ FunctionProtoToString()

MaybeLocal<String> v8::Function::FunctionProtoToString ( Local< Context context)

Calls builtin Function.prototype.toString on this function. This is different from Value::ToString() that may call a user-defined toString() function, and different than Object::ObjectProtoToString() which always serializes "[object Function]".

◆ GetBoundFunction()

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

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

◆ GetDebugName()

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

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

◆ GetDisplayName()

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.

◆ GetInferredName()

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.

◆ GetName()

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

◆ GetScriptColumnNumber()

int v8::Function::GetScriptColumnNumber ( ) const

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

◆ GetScriptLineNumber()

int v8::Function::GetScriptLineNumber ( ) const

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

◆ GetScriptOrigin()

ScriptOrigin v8::Function::GetScriptOrigin ( ) const

◆ New()

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

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

◆ NewInstance() [1/2]

MaybeLocal<Object> v8::Function::NewInstance ( Local< Context context) const
inline

◆ NewInstance() [2/2]

MaybeLocal<Object> v8::Function::NewInstance ( Local< Context context,
int  argc,
Local< Value argv[] 
) const

◆ NewInstanceWithSideEffectType()

MaybeLocal<Object> v8::Function::NewInstanceWithSideEffectType ( Local< Context context,
int  argc,
Local< Value argv[],
SideEffectType  side_effect_type = SideEffectType::kHasSideEffect 
) const

When side effect checks are enabled, passing kHasNoSideEffect allows the constructor to be invoked without throwing. Calls made within the constructor are still checked.

◆ ScriptId()

int v8::Function::ScriptId ( ) const

Returns scriptId.

◆ SetName()

void v8::Function::SetName ( Local< String name)

Member Data Documentation

◆ kLineOffsetNotFound

const int v8::Function::kLineOffsetNotFound
static

The documentation for this class was generated from the following file: