Skip to content

Commit b00b5af

Browse files
committed
Rework the public API
Related to jerryscript-project#4186. Some notable changes: - The term 'Error' now strictly refers to native Error objects defined in the ECMA standard, which are ordinary objects. All other uses of 'error', where it refers to a thrown value (called error reference) is now called 'exception'. - Simplified the naming scheme of many String API functions. These functions will now also take an 'encoding' argument to specify the desired encoding in which to operate. - Removed the substring-copy-to-buffer functions. These functions behaved awkwardly, as they use character index to specify the start/end positions, and were mostly used incorrectly with byte offsets instead. The functionality can still be replicated with other functions if necessary. - String-to-buffer functions will no longer fail if the buffer is not sufficiently large, the string will instead be cropped. - Fixed the usage of the '_sz' prefix in many API functions. The term 'sz' means zero-terminated string in hungarian notation, this was used incorrectly in many cases. - Renamed most of the public API functions to have shorter, more on-point names, rather than the often too long descriptive names. Functions are now also grouped by the type of value they operate on, where this makes sense. JerryScript-DCO-1.0-Signed-off-by: Dániel Bátyai [email protected]
1 parent 4592143 commit b00b5af

File tree

158 files changed

+10021
-10337
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

158 files changed

+10021
-10337
lines changed

docs/01.CONFIGURATION.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -190,7 +190,7 @@ This option is enabled by default.
190190

191191
### Memory statistics
192192

193-
This option can be used to provide memory usage statistics either upon engine termination, or during runtime using the `jerry_get_memory_stats` jerry API function.
193+
This option can be used to provide memory usage statistics either upon engine termination, or during runtime using the `jerry_heap_stats` jerry API function.
194194
The feature can create a significant performance overhead, and should only be used for measurement purposes. This option is disabled by default.
195195

196196
| Options | |

docs/02.API-REFERENCE.md

+2,105-2,533
Large diffs are not rendered by default.

0 commit comments

Comments
 (0)