v8 12.4.254 (node 22.4.1)
V8 is Google's open source JavaScript engine
Loading...
Searching...
No Matches
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< ObjectHolder () 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
 

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 109 of file v8-function-callback.h.

Member Function Documentation

◆ Data()

template<typename T >
Local< Value > Data

The data argument specified when creating the callback.

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

◆ GetIsolate()

template<typename T >
Isolate * GetIsolate

The current Isolate.

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

◆ GetReturnValue()

template<typename T >
ReturnValue< T > GetReturnValue

The ReturnValue for the call.

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

◆ Holder()

template<typename T >
Local< Object > Holder

If the callback was created without a Signature, this is the same value as This(). If there is a signature, and the signature didn't match This() but one of its hidden prototypes, this will be the respective hidden prototype.

Note that this is not the prototype of This() on which the accessor referencing this callback was found (which in V8 internally is often referred to as holder [sic]).

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

◆ IsConstructCall()

template<typename T >
bool IsConstructCall

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

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

◆ Length()

template<typename T >
int Length

The number of available arguments.

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

◆ NewTarget()

template<typename T >
Local< Value > NewTarget

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

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

◆ 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 522 of file v8-function-callback.h.

References v8::Undefined().

◆ This()

template<typename T >
Local< Object > This

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

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

Friends And Related Symbol Documentation

◆ debug::ConsoleCallArguments

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

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

◆ internal::CustomArguments< FunctionCallbackInfo >

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

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

◆ internal::FunctionCallbackArguments

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

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


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