v8 13.6.233 (node 24.1.0)
V8 is Google's open source JavaScript engine
All Data Structures Namespaces Files Functions Variables Typedefs Enumerations Enumerator Friends Macros Pages Concepts
FunctionCallbackInfo< T > Class Template Reference

#include <v8-function-callback.h>

Public Member Functions

V8_INLINE int Length () const
 
V8_INLINE Local< Valueoperator[] (int i) const
 
V8_INLINE Local< ObjectThis () const
 
V8_INLINE Local< ValueNewTarget () const
 
V8_INLINE bool IsConstructCall () const
 
V8_INLINE Local< ValueData () const
 
V8_INLINE IsolateGetIsolate () const
 
V8_INLINE ReturnValue< T > GetReturnValue () const
 

Friends

class internal::FunctionCallbackArguments
 
class internal::CustomArguments< FunctionCallbackInfo >
 
class debug::ConsoleCallArguments
 
void internal::PrintFunctionCallbackInfo (void *)
 

Detailed Description

template<typename T>
class v8::FunctionCallbackInfo< T >

The argument information given to function call callbacks. This class provides access to information about the context of the call, including the receiver, the number and values of arguments, and the holder of the function.

Definition at line 118 of file v8-function-callback.h.

Member Function Documentation

◆ Data()

template<typename T>
Local< Value > Data ( ) const

The data argument specified when creating the callback.

Definition at line 639 of file v8-function-callback.h.

References v8::api_internal::GetFunctionTemplateData(), and GetIsolate().

◆ GetIsolate()

template<typename T>
Isolate * GetIsolate ( ) const

The current Isolate.

Definition at line 645 of file v8-function-callback.h.

Referenced by Data(), and operator[]().

◆ GetReturnValue()

template<typename T>
ReturnValue< T > GetReturnValue ( ) const

The ReturnValue for the call.

Definition at line 650 of file v8-function-callback.h.

◆ IsConstructCall()

template<typename T>
bool IsConstructCall ( ) const

Indicates whether this is a regular call or a construct call.

Definition at line 655 of file v8-function-callback.h.

References NewTarget().

◆ Length()

template<typename T>
int Length ( ) const

The number of available arguments.

Definition at line 660 of file v8-function-callback.h.

Referenced by operator[]().

◆ NewTarget()

template<typename T>
Local< Value > NewTarget ( ) const

For construct calls, this returns the "new.target" value.

Definition at line 634 of file v8-function-callback.h.

Referenced by IsConstructCall().

◆ operator[]()

template<typename T>
Local< Value > operator[] ( int i) const

Accessor for the available arguments. Returns undefined if the index is out of bounds.

Definition at line 621 of file v8-function-callback.h.

References GetIsolate(), Length(), and v8::Undefined().

◆ This()

template<typename T>
Local< Object > This ( ) const

Returns the receiver. This corresponds to the "this" value.

Definition at line 628 of file v8-function-callback.h.

Friends And Related Symbol Documentation

◆ debug::ConsoleCallArguments

template<typename T>
friend class debug::ConsoleCallArguments
friend

Definition at line 143 of file v8-function-callback.h.

References debug::ConsoleCallArguments.

Referenced by debug::ConsoleCallArguments.

◆ internal::CustomArguments< FunctionCallbackInfo >

template<typename T>
friend class internal::CustomArguments< FunctionCallbackInfo >
friend

Definition at line 141 of file v8-function-callback.h.

References internal::FunctionCallbackArguments.

◆ internal::FunctionCallbackArguments

template<typename T>
friend class internal::FunctionCallbackArguments
friend

◆ internal::PrintFunctionCallbackInfo

template<typename T>
void internal::PrintFunctionCallbackInfo ( void * )
friend

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