windows-eventlog-reader - npm Package Compare versions

Comparing version 1.0.2 to 1.0.3

package.json

 {
   "name": "windows-eventlog-reader",
-  "version": "1.0.2",
+  "version": "1.0.3",
   "description": "Read windows event logs",
@@ -5,0 +5,0 @@ "main": "index.js",

README.md

@@ -5,3 +5,3 @@
 This modules provides [Node.js][nodejs] programs the ability to read events
-from a Windows Event Log.
+from a Windows event log.
 
@@ -71,3 +71,3 @@ This module is installed using [node package manager (npm)][npm]:
 function will call the Win32 API function `CloseEventLog()`, which might
-block.  However during development this function always seemed to return
+block.  However, during development this function always seemed to return
 pretty much instantly.
@@ -87,2 +87,3 @@
         timeWritten: 1372576636,
+        eventId: 5104,
         eventType: 'Information',
@@ -104,8 +105,17 @@ eventCategory: 0,
    date and time at which the event was actually written to the event log
+ * `eventId` - Number specifying the event identifier, this is specifiec to
+   the event source
  * `eventType` - String specifying event type, this can be one of `Error`,
    `Warning`, `Information`, `AuditSuccess`, `AuditFailure` or `Unknown`
  * `eventCategory` - Number specifying the event category, this is specific
-   to the event and not defined by this module
+   to the event source and is not defined by this module
  * `message` - String containing the formatted event message
 
+Event identifiers, i.e. the `eventId` attribute, contain multiple sub-fields.
+Refer to Win32 API documentation for details on each field.  To obtain the
+event code field, as it is displayed in the Windows event log viewer, bitwise
+`&` the `eventId` attribute with `0xffff`:
+
+    var eventCode = event.eventId & 0xffff;
+
 # Error Handling
@@ -219,2 +229,20 @@
 
+## reader.close ()
+
+The `close()` method closes the underlying Windows event log represented by
+the reader.
+
+**NOTE** This function will call the Win32 API function `CloseEventLog()`,
+which might block. However, during development this function always seemed to
+return pretty much instantly.
+
+The following example opens the `Application` Windows event log:
+
+    reader.open (function (error) {
+        if (error)
+            console.error (error.toString ());
+        else
+            reader.close ();
+    });
+
 ## reader.read (offset, feedCallback, doneCallback)
@@ -399,2 +427,7 @@
 
+## Version 1.0.3 - 11/07/2013
+
+ * Added `eventId` attribute to the event object
+ * Added missing documentation for the `close()` method to the README.md file
+
 # Roadmap
@@ -401,0 +434,0 @@

No alert changes

Improved metrics

Total package byte prevSize

38829

increased by3.45%

Number of lines in readme file

454

increased by7.84%

No dependency changes