Skip to content

Commit b313824

Browse files
authored
Update API docs for 2.4 release (#4504)
Replace the [[NEXT_VERSION]] entries with the exact version number in the API reference documentation. JerryScript-DCO-1.0-Signed-off-by: Peter Gal [email protected]
1 parent 2ade072 commit b313824

File tree

1 file changed

+36
-32
lines changed

1 file changed

+36
-32
lines changed

docs/02.API-REFERENCE.md

Lines changed: 36 additions & 32 deletions
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ Enum that contains JerryScript API value types:
3131

3232
*New in version 2.0*.
3333

34-
*Changed in [[NEXT_RELEASE]]*: Added `JERRY_TYPE_BIGINT` value.
34+
*Changed in version 2.4*: Added `JERRY_TYPE_BIGINT` value.
3535

3636
## jerry_object_type_t
3737

@@ -56,7 +56,7 @@ Enum that contains JerryScript **object** value types:
5656
- JERRY_OBJECT_TYPE_GENERATOR - Generator object
5757
- JERRY_OBJECT_TYPE_BIGINT - BigInt object
5858

59-
*New in version [[NEXT_RELEASE]]*.
59+
*New in version 2.4*.
6060

6161
## jerry_function_type_t
6262

@@ -69,7 +69,7 @@ Enum that contains JerryScript **function** value types:
6969
- JERRY_FUNCTION_TYPE_ARROW - Arrow fuction
7070
- JERRY_FUNCTION_TYPE_GENERATOR - Generator function object
7171

72-
*New in version [[NEXT_RELEASE]]*.
72+
*New in version 2.4*.
7373

7474
## jerry_iterator_type_t
7575

@@ -81,7 +81,7 @@ Enum that contains JerryScript **iterator** value types:
8181
- JERRY_ITERATOR_TYPE_MAP - Map iterator
8282
- JERRY_ITERATOR_TYPE_SET - Set iterator
8383

84-
*New in version [[NEXT_RELEASE]]*.
84+
*New in version 2.4*.
8585

8686
## jerry_property_filter_t
8787

@@ -97,7 +97,7 @@ Enum that contains JerryScript **property filter** options bits:
9797
- JERRY_PROPERTY_FILTER_EXLCUDE_INTEGER_INDICES - Exclude property key if it is an integer index
9898
- JERRY_PROPERTY_FILTER_INTEGER_INDICES_AS_NUMBER - By default integer index property keys are converted to string. Enabling this flags keeps integer index property keys as numbers
9999

100-
*New in version [[NEXT_RELEASE]]*.
100+
*New in version 2.4*.
101101

102102
## jerry_error_t
103103

@@ -149,9 +149,9 @@ Possible compile time enabled feature types:
149149

150150
*New in version 2.0*.
151151

152-
*Changed in version 2.3* : Added `JERRY_FEATURE_WEAKMAP`, `JERRY_FEATURE_WEAKSET` values.
152+
*Changed in version 2.3*: Added `JERRY_FEATURE_WEAKMAP`, `JERRY_FEATURE_WEAKSET` values.
153153

154-
+*Changed in [[NEXT_RELEASE]]*: Added `JERRY_FEATURE_BIGINT`, `JERRY_FEATURE_REALM` values.
154+
*Changed in version 2.4*: Added `JERRY_FEATURE_BIGINT`, `JERRY_FEATURE_REALM` values.
155155

156156
## jerry_container_type_t
157157

@@ -182,7 +182,7 @@ Well-known symbols:
182182
- JERRY_SYMBOL_TO_STRING_TAG - @@toStringTag well-known symbol
183183
- JERRY_SYMBOL_UNSCOPABLES - @@unscopables well-known symbol
184184

185-
*New in version [[NEXT_RELEASE]]*.
185+
*New in version 2.4*.
186186

187187
## jerry_regexp_flags_t
188188

@@ -202,7 +202,8 @@ RegExp object optional flags:
202202

203203

204204
*New in version 2.0*.
205-
*Changed in version[[NEXT_RELEASE]]* : Added `JERRY_REGEXP_FLAG_STICKY`, `JERRY_REGEXP_FLAG_UNICODE` , `JERRY_REGEXP_FLAG_DOTALL` values.
205+
206+
*Changed in version 2.4*: Added `JERRY_REGEXP_FLAG_STICKY`, `JERRY_REGEXP_FLAG_UNICODE` , `JERRY_REGEXP_FLAG_DOTALL` values.
206207

207208

208209
## jerry_parse_opts_t
@@ -215,6 +216,7 @@ Option bits for [jerry_parse](#jerry_parse) and
215216
- JERRY_PARSE_MODULE - parse source as an ECMAScript module
216217

217218
*New in version 2.0*.
219+
218220
*Changed in version 2.4: Added `JERRY_PARSE_MODULE`.*
219221

220222
## jerry_gc_mode_t
@@ -598,8 +600,6 @@ Error object.
598600
- The callback function cannot be called recursively, so the Error objects created
599601
when the callback is running are not updated.
600602

601-
*New in version [[NEXT_RELEASE]]*.
602-
603603
**Prototype**
604604

605605
```c
@@ -609,6 +609,8 @@ typedef void (*jerry_error_object_created_callback_t) (const jerry_value_t error
609609
- `error_object` - the newly created Error object.
610610
- `user_p` - pointer passed to [jerry_set_error_object_created_callback](#jerry_set_error_object_created_callback).
611611

612+
*New in version 2.4*.
613+
612614
**See also**
613615

614616
- [jerry_set_error_object_created_callback](#jerry_set_error_object_created_callback)
@@ -791,7 +793,7 @@ TypedArray support is not in the engine.
791793

792794
*New in version 2.0*.
793795

794-
*Changed in version [[NEXT_RELEASE]]*: Added `JERRY_TYPEDARRAY_BIGINT64`, `JERRY_TYPEDARRAY_BIGUINT64` values.
796+
*Changed in version 2.4*: Added `JERRY_TYPEDARRAY_BIGINT64`, `JERRY_TYPEDARRAY_BIGUINT64` values.
795797

796798
**See also**
797799

@@ -1894,6 +1896,8 @@ jerry_value_is_async_function (const jerry_value_t value)
18941896
- true, if the given `jerry_value_t` is an async function
18951897
- false, otherwise
18961898

1899+
*New in version 2.4*.
1900+
18971901
**Example**
18981902

18991903
```c
@@ -2253,7 +2257,7 @@ jerry_value_is_bigint (const jerry_value_t value)
22532257
- true, if the given `jerry_value_t` is a BigInt
22542258
- false, otherwise
22552259

2256-
*New in version [[NEXT_RELEASE]]*.
2260+
*New in version 2.4*.
22572261

22582262
**Example**
22592263

@@ -2515,7 +2519,7 @@ jerry_object_get_type (const jerry_value_t value);
25152519
- return value
25162520
- One of the [jerry_object_type_t](#jerry_object_type_t) value.
25172521

2518-
*New in version [[NEXT_RELEASE]]*.
2522+
*New in version 2.4*.
25192523

25202524
**Example**
25212525

@@ -2558,7 +2562,7 @@ jerry_function_get_type (const jerry_value_t value);
25582562

25592563
Note: For non-function parameters `JERRY_FUNCTION_TYPE_NONE` is returned.
25602564

2561-
*New in version [[NEXT_RELEASE]]*.
2565+
*New in version 2.4*.
25622566

25632567
**Example**
25642568

@@ -2602,7 +2606,7 @@ jerry_iterator_get_type (const jerry_value_t value);
26022606

26032607
Note: For non-iterator parameters `JERRY_ITERATOR_TYPE_NONE` is returned.
26042608

2605-
*New in version [[NEXT_RELEASE]]*.
2609+
*New in version 2.4*.
26062610

26072611
**Example**
26082612

@@ -3040,7 +3044,7 @@ void jerry_set_error_object_created_callback (jerry_error_object_created_callbac
30403044
disables the operation
30413045
- `user_p` - pointer passed to the callback function, can be NULL
30423046

3043-
*New in version [[NEXT_RELEASE]]*.
3047+
*New in version 2.4*.
30443048

30453049
**Example**
30463050

@@ -3839,7 +3843,7 @@ jerry_value_to_bigint (const jerry_value_t value);
38393843
- converted BigInt value, if success
38403844
- thrown error, otherwise
38413845

3842-
*New in version [[NEXT_RELEASE]]*.
3846+
*New in version 2.4*.
38433847

38443848
**Example**
38453849

@@ -4165,7 +4169,7 @@ jerry_to_property_descriptor (jerry_value_t obj_value, jerry_property_descriptor
41654169
- true, if success
41664170
- thrown error, otherwise
41674171

4168-
*New in version [[NEXT_RELEASE]]*.
4172+
*New in version 2.4*.
41694173

41704174
**Example**
41714175

@@ -4288,7 +4292,7 @@ jerry_get_well_known_symbol (jerry_well_known_symbol_t symbol);
42884292
- undefined value - if invalid well-known symbol was requested
42894293
- well-known symbol value, otherwise
42904294

4291-
*New in version [[NEXT_RELEASE]]*.
4295+
*New in version 2.4*.
42924296

42934297
**Example**
42944298

@@ -4348,7 +4352,7 @@ jerry_get_symbol_description (const jerry_value_t value);
43484352
- string or undefined value containing the symbol's description - if success
43494353
- thrown error, otherwise
43504354

4351-
*New in version [[NEXT_RELEASE]]*.
4355+
*New in version 2.4*.
43524356

43534357
**Example**
43544358

@@ -4477,7 +4481,7 @@ jerry_get_bigint_size_in_digits (jerry_value_t value)
44774481
- number of digits (can be zero for BigInt zero)
44784482
- if value is not a BigInt value, it returns with zero
44794483

4480-
*New in version [[NEXT_RELEASE]]*.
4484+
*New in version 2.4*.
44814485

44824486
**Example**
44834487

@@ -4540,7 +4544,7 @@ jerry_get_bigint_digits (jerry_value_t value, uint64_t *digits_p, uint32_t size,
45404544
- `sign_p` - the boolean passed to the function is set to false when the BigInt
45414545
is positive, and set to true otherwise (this parameter can be NULL)
45424546

4543-
*New in version [[NEXT_RELEASE]]*.
4547+
*New in version 2.4*.
45444548

45454549
**Example**
45464550

@@ -4603,7 +4607,7 @@ jerry_get_proxy_target (jerry_value_t proxy_value)
46034607
- type error - if proxy_value is not a Proxy object
46044608
- target object - otherwise
46054609

4606-
*New in version [[NEXT_RELEASE]]*.
4610+
*New in version 2.4*.
46074611

46084612
**Example**
46094613

@@ -5573,7 +5577,7 @@ jerry_create_external_string (const jerry_char_t *str_p,
55735577
- `free_cb` - optional callback which is called right before the string is freed
55745578
- return value - value of the created string
55755579

5576-
*New in version [[NEXT_RELEASE]]*.
5580+
*New in version 2.4*.
55775581

55785582
**Example**
55795583

@@ -5620,7 +5624,7 @@ jerry_create_external_string_sz (const jerry_char_t *str_p,
56205624
- `free_cb` - optional callback which is called right before the string is freed
56215625
- return value - value of the created string
56225626

5623-
*New in version [[NEXT_RELEASE]]*.
5627+
*New in version 2.4*.
56245628

56255629
**Example**
56265630

@@ -5729,7 +5733,7 @@ jerry_create_bigint (const uint64_t *digits_p, uint32_t size, bool sign)
57295733
- value of the created bigint, if success
57305734
- thrown error, otherwise
57315735

5732-
*New in version [[NEXT_RELEASE]]*.
5736+
*New in version 2.4*.
57335737

57345738
**Example**
57355739

@@ -6127,7 +6131,7 @@ jerry_create_realm (void);
61276131

61286132
- return value - realm object value
61296133

6130-
*New in version [[NEXT_RELEASE]]*.
6134+
*New in version 2.4*.
61316135

61326136
**Example**
61336137

@@ -9064,7 +9068,7 @@ jerry_get_backtrace_from (uint32_t max_depth, jerry_value_t ignored_function);
90649068
- return value
90659069
- a newly constructed JS array
90669070

9067-
*New in version [[NEXT_RELEASE]]*.
9071+
*New in version 2.4*.
90689072

90699073
**Example**
90709074

@@ -9437,7 +9441,7 @@ jerry_set_realm (jerry_value_t realm_value);
94379441
- previous realm value - if the passed value is a realm
94389442
- exception - otherwise
94399443

9440-
*New in version [[NEXT_RELEASE]]*.
9444+
*New in version 2.4*.
94419445

94429446
**Example**
94439447

@@ -9482,7 +9486,7 @@ jerry_realm_get_this (jerry_value_t realm_value)
94829486
- type error - if realm_value is not a realm
94839487
- 'this' binding object - otherwise
94849488

9485-
*New in version [[NEXT_RELEASE]]*.
9489+
*New in version 2.4*.
94869490

94879491
**Example**
94889492

@@ -9529,7 +9533,7 @@ jerry_realm_set_this (jerry_value_t realm_value, jerry_value_t this_value)
95299533
- type error - if realm_value is not a realm or this_value is not object
95309534
- true - otherwise
95319535

9532-
*New in version [[NEXT_RELEASE]]*.
9536+
*New in version 2.4*.
95339537

95349538
**Example**
95359539

0 commit comments

Comments
 (0)