Skip to content

Commit

Permalink
doc: refine napi_get_property_names() doc
Browse files Browse the repository at this point in the history
Document that only enumerable, string-keyed properties are returned.

Fixes: nodejs/abi-stable-node#307
PR-URL: #20427
Reviewed-By: Tiancheng "Timothy" Gu <timothygu99@gmail.com>
Reviewed-By: Michael Dawson <michael_dawson@ca.ibm.com>
Reviewed-By: Vse Mozhet Byt <vsemozhetbyt@gmail.com>
  • Loading branch information
Gabriel Schulhof authored and MylesBorins committed May 4, 2018
1 parent b61ae7f commit d7557e1
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/api/n-api.md
Original file line number Diff line number Diff line change
Expand Up @@ -2520,7 +2520,9 @@ and [`napi_get_element`][].

Returns `napi_ok` if the API succeeded.

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

#### napi_set_property
<!-- YAML
Expand Down

0 comments on commit d7557e1

Please sign in to comment.