Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

fix doc #23

Open
wants to merge 8 commits into
base: master
Choose a base branch
from
Open

fix doc #23

Changes from 2 commits
Commits
Show all changes
8 commits
Select commit Hold shift + click to select a range
184832d
fix example
MoonBall Jan 14, 2022
b78e7ac
use local handles rather than Local/Handles
MoonBall Jan 14, 2022
18a3c67
fix doc
MoonBall Jan 15, 2022
36add47
add link of escapable_handlescope_test example
MoonBall Jan 15, 2022
8e5bc72
fix doc
MoonBall Jan 15, 2022
b2e5773
fix doc
MoonBall Jan 16, 2022
a93e2c5
remove unnecessary type conversion
MoonBall Jan 16, 2022
2974549
fix doc
MoonBall Jan 16, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
8 changes: 4 additions & 4 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -392,7 +392,7 @@ is of a certain type, like `IsUndefined()`, `IsNull`, `IsNumber` etc.
It also has useful methods to convert to a Local<T>, for example:
```c++
V8_WARN_UNUSED_RESULT MaybeLocal<Number> ToNumber(Local<Context> context) const;
V8_WARN_UNUSED_RESULT MaybeLocal<String> ToNumber(Local<String> context) const;
V8_WARN_UNUSED_RESULT MaybeLocal<String> ToString(Local<Context> context) const;
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The example code is from https://github.com/v8/v8/blob/ee74e718339223345b42935e9f4cbc7be208e557/include/v8-value.h#L355-L361

...
```

Expand Down Expand Up @@ -452,9 +452,9 @@ $19 = 0x5
See [handle_test.cc](./test/handle_test.cc) for an example.

### HandleScope
Contains a number of Local/Handle's (think pointers to objects but is managed
by V8) and will take care of deleting the Local/Handles for us. HandleScopes
are stack allocated
Contains a number of local handles (like pointers to objects but are managed
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

In v8's source code, they use local handles rather than Local/Handles.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think Local is essentially equivalent to Handle. The difference of them is Local is an outer api and Handle is an inner api.

So we can simplify the doc by omitting the Local.

by V8) and will take care of deleting the local handles for us. HandleScopes
are stack allocated.

When ~HandleScope is called all handles created within that scope are removed
from the stack maintained by the HandleScope which makes objects to which the
Expand Down