Convert all locals and parameter names to snake_case #193
Conversation
Standardize some parameter names across the N-API surface such as ```napi_env env``` and ```size_t length```. Make all the parameter names in the header match the cc file and expand some parameter names from single characters into meaningful words. Also addresses a couple of minor PR feedback items: - Rename ```napi_reference_addref``` and ```napi_reference_release``` to ```napi_reference_ref``` and ```napi_reference_unref``` (respectively) - Rename ```Reference::AddRef``` and ```Reference::Release``` to ```Reference::Ref``` and ```Reference::Unref``` (respectively) - Remove ```napi_create_boolean```, ```napi_get_true```, and ```napi_get_false``` and replace them with ```napi_get_boolean``` - Rename ```napi_get_type_of_value``` to ```napi_typeof``` - Add a ```result_data``` out parameter to ```napi_create_buffer_copy``` which returns the data pointer of the new buffer - Change ```napi_get_value_string_utf8``` and ```napi_get_value_string_utf16``` to accept a null output buffer and return the length of the source string in that case via the ```result``` parameter - Remove ```napi_get_value_string_utf8_length``` and ```napi_get_value_string_utf16_length``` due to the above - Change ```Reference``` ctor and dtor to be protected and added public ```static Reference* Reference::New``` and ```static void Reference::Delete``` methods to make it more clear how the ```Reference``` objects are allocated and cleaned-up - Add a type check to ``napi_get_array_length``` which returns an error if the argument is not an array object - Change ```napi_create_symbol``` to take a ```napi_value``` instead of a ```const char*``` for the symbol description string. The API now throws if description is not a string but NULL is allowed.
The latin1 string API PR will need these changes (whichever PR goes second). |
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
This comment was marked as off-topic.
This comment was marked as off-topic.
Sorry, something went wrong.
Standardize some parameter names across the N-API surface such as
napi_env envandsize_t length. Make all the parameter names in the header match the cc file and expand some parameter names from single characters into meaningful words.Also addresses a couple of minor PR feedback items:
napi_reference_addrefandnapi_reference_releasetonapi_reference_refandnapi_reference_unref(respectively)Reference::AddRefandReference::ReleasetoReference::RefandReference::Unref(respectively)napi_create_boolean,napi_get_true, andnapi_get_falseand replace them withnapi_get_booleannapi_get_type_of_valuetonapi_typeofresult_dataout parameter tonapi_create_buffer_copywhich returns the data pointer of the new buffernapi_get_value_string_utf8andnapi_get_value_string_utf16to accept a null output buffer and return the length of the source string in that case via theresultparameternapi_get_value_string_utf8_lengthandnapi_get_value_string_utf16_lengthdue to the aboveReferencector and dtor to be protected and added publicstatic Reference* Reference::Newandstatic void Reference::Deletemethods to make it more clear how theReferenceobjects are allocated and cleaned-upnapi_get_array_lengthwhich returns an error if the argument is not an array objectnapi_create_symbolto take anapi_valueinstead of aconst char*for the symbol description string. The API now throws if description is not a string but NULL is allowed.Addresses #189 and #188 and some feedback in nodejs/node#11975.