@slimio/winelog

Winelog

Windows Events log reader - Node.JS low-level binding

Requirements

• Node.js v13 or higher

Getting Started

This package is available in the Node Package Repository and can be easily installed with npm or yarn.

$ npm i @slimio/winelog
# or
$ yarn add @slimio/winelog

Usage example

const { readEventLog, files } = require("@slimio/winelog");

async function main() {
    for await (const event of readEventLog(files.Security)) {
        console.log(event);
        break;
    }
}
main().catch(console.error);

API

readEventLog(logName: keyof EventsLogFiles, reverseDirection?: boolean): AsyncIterableIterator< EventLog >

Read a given event log in reverse direction (direction can be updated to be forward). Return an Async Iterable that can be stopped at any time.

interface EventLog {
    eventId: number;
    providerName: string;
    providerGUID: string;
    channel: string;
    computer: string;
    timeCreated: string;
    level: number;
    task: number;
    opcode: number;
    keywords: number;
    eventRecordID: number;
    processID: number;
    threadID: number;
}

Contribution Guidelines

To contribute to the project, please read the code of conduct and the guide for N-API compilation.

Dependencies

Name	Refactoring	Security Risk	Usage
node-addon-api	⚠️Major	Low	Node.js C++ addon api
node-gyp-build	⚠️Major	Low	Node-gyp builder

License

MIT