<commit_before># Node-NUT

Node-NUT is a NodeJS module that implements a NUT (Network UPS Tools) client.

## Events

### ready

This event is emitted when the connection to the NUT server is established.

### error

Emitted when there was an error establishing the connection or with the network communication to
the server.

### close

Emitted when the connection to the NUT server is closed.

## Functions (tested)
<commit_msg>add compatibility note to README<commit_after># Node-NUT

Node-NUT is a NodeJS module that implements a NUT (Network UPS Tools) client.

## Version compatibility information
v1.0.0 introduce callbacks into all functions including a second "error" parameter for all gameaccounts. This error parameter is null on success or a text on error. Please see the updated method documentation below.

This change should not break existing code because you can simply ignore the second parameter, but there is one change coming with it:

When with v0.0.x an error occured in one of the "Get-List-Of" methods then the callback was pot. never called at all. This has changed now because now the callback is also called in errorcases, but then with an empty object/list in return. So you may want to include error handling code that not strange things happens in error cases.

## Events

### ready

This event is emitted when the connection to the NUT server is established.

### error

Emitted when there was an error establishing the connection or with the network communication to
the server.

### close

Emitted when the connection to the NUT server is closed.

## Functions (tested)

{'fraction_non_alphanumeric': 0.048034934497816595, 'fraction_numerical': 0.0031191515907673115, 'mean_word_length': 4.293729372937293, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '1710269', 'n_tokens_mistral': 403, 'n_tokens_neox': 394, 'n_words': 244}