Documentation Improvements: How to do basic things with ChakraCore about chakracore-wiki HOT 9 OPEN

Might want to add "Embed JavaScript functions in C/C++"... This may not be used very often, but there is cases where the implementation of a function is a lot easier to use JavaScript than it is C/C++.

// This is the toString function defined using JavaScript, 
// but is embedded in C/C++ code.
function toString() {
  return `Point (${this.x}, ${this.y}, ${this.z})`
}

from chakracore-wiki.

NOTE: new edits to the list will be added to the main post instead of to this comment.

Good input. I think I've done all of those in this sample, but some documentation with small code snippets would've been more helpful. I'll look into it when I'm free.

Creating a list of topics,

• Expose native functions / external objects to JavaScript
• Handle object lifetime
• Implement a simple event-loop and task queue + using promises in JSRT
• Script serialization with lazy source loading
• Resource throttling
• Define non-writable property from C/C++(a.k.a. using descriptor)
• Define C/C++ Getter and Setter
• TypedArray handling in C/C++

Edited:
Add some stuff per microsoft/Chakra-Samples#51 @kphillisjr

from chakracore-wiki.

Something that would provide a lot of value. Something quiet common is how to wrap a c++ object so it is accessible from js.

Something similar to https://chromium.googlesource.com/v8/v8/+/master/samples/process.cc would be good.

from chakracore-wiki.

Yeah. I think this one (I added "external objects" just now) on my list would help,

Expose native functions / external objects to JavaScript

from chakracore-wiki.

Great :)

from chakracore-wiki.

Updated list in the main post so we get the progress meter from the issues page as we complete these items.

from chakracore-wiki.

@dilijev It would be good to call out that the samples should be accessible cross platform as well as just windows. The opengl sample is great, but uses some windows only features.

from chakracore-wiki.

@jaredwy -- Makes sense. For the APIs that are xplat-compatible, the samples should be xplat-compatible. But because they are example snippets, they might not compile on their own without setting up a project like the samples do. Short samples in documentation will not be perfect and super easy, but may be possible to copy-paste into an existing project.

For the Windows-only APIs, they'll obviously only work on Windows. There are a few of these.

from chakracore-wiki.

@dilijev Yup. It would be good just to avoid things like JSPointerToString and JsGetPropertyNameFromId even in projects that are windows only and c++. That is what threw me the most. I was using the opengl sample as a guide and ended up being thrown when attempting to compile copy and pasted code :)

from chakracore-wiki.