Skip to content

Commit d7557e1

Browse files
Gabriel SchulhofMylesBorins
Gabriel Schulhof
authored andcommitted
doc: refine napi_get_property_names() doc
Document that only enumerable, string-keyed properties are returned. Fixes: nodejs/abi-stable-node#307 PR-URL: #20427 Reviewed-By: Tiancheng "Timothy" Gu <[email protected]> Reviewed-By: Michael Dawson <[email protected]> Reviewed-By: Vse Mozhet Byt <[email protected]>
1 parent b61ae7f commit d7557e1

File tree

1 file changed

+3
-1
lines changed

1 file changed

+3
-1
lines changed

doc/api/n-api.md

+3-1
Original file line numberDiff line numberDiff line change
@@ -2520,7 +2520,9 @@ and [`napi_get_element`][].
25202520

25212521
Returns `napi_ok` if the API succeeded.
25222522

2523-
This API returns the array of properties for the `Object` passed in.
2523+
This API returns the names of the enumerable properties of `object` as an array
2524+
of strings. The properties of `object` whose key is a symbol will not be
2525+
included.
25242526

25252527
#### napi_set_property
25262528
<!-- YAML

0 commit comments

Comments
 (0)