# node_memory_reader

> Package for node that reads bytes from memory for a given process

Latest version **2.0.0** (published 2023-10-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install node_memory_reader
pnpm add node_memory_reader
yarn add node_memory_reader
bun add node_memory_reader
```

## Health

**Score 25/100 (F)** — status: abandoned.

Positive: has types; no vulnerabilities; high quality score.

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 2.0.0 |
| Published | 2023-10-09 |
| First published | 2023-10-07 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | CommonJS |
| Dependencies | 1 |
| Unpacked size | 21.6 KB |
| Known vulnerabilities | 0 |
| Install scripts | yes |
| GitHub stars | 1 |
| Author | joachima94@gmail.com |
| Maintainers | joachiman |
| Keywords | memory, process |

## Links

- npm: https://www.npmjs.com/package/node_memory_reader
- Repository: https://github.com/joffe97/node_memory_reader
- Homepage: https://github.com/joffe97/node_memory_reader#readme
- Issues: https://github.com/joffe97/node_memory_reader/issues
- npm.io page: https://npm.io/package/node_memory_reader

## Dependencies (1)

- [cargo-cp-artifact](https://npm.io/package/cargo-cp-artifact.md) ^0.1

## Recent versions

- 2.0.0 (latest) — 2023-10-09
- 1.0.1 — 2023-10-08
- 1.0.0 — 2023-10-07
- 0.1.0 — 2023-10-07

## README

# Node memory reader
This is a package for node that reads data from memory from a given process.

## Methods
### readMemory
```ts
readMemory(pid: number, address: number, length: number) -> number[]
```

##### Arguments
* pid: Process id of the process that are being read
* address: Relative memory address of the first byte
* length: Number of bytes

##### Return
The returned value is an array of `length` amount of bytes; starting from the relative `address` in the process with process id `pid`.

##### Example
```ts
import * as nodeMemoryReader from "node_memory_reader";
let memory: number[] = nodeMemoryReader.readMemory(41462, 0x4052a0, 20);
```


### readMemoryWithDataSize
```ts
readMemoryWithDataSize(pid: number, address: number, length: number, dataTypeSize: DataTypeSize) -> number[]
```

##### Arguments
* pid: Process id of the process that are being read
* address: Relative memory address of the first byte
* length: Number of bytes
* dataTypeSize: Size of the returned data size

##### Return
The returned value is an array of `length` amount of values with the size of `dataTypeSize`; starting from the relative `address` in the process with process id `pid`.

##### Example
```ts
import * as nodeMemoryReader from "node_memory_reader";
let memory: number[] = nodeMemoryReader.readMemoryWithDataSize(41462, 0x4052a0, 1, nodeMemoryReader.B32);
```


## Note
This package is compatible with Linux and Windows.

MacOS support is not considered at the moment.

---
_Source: https://npm.io/package/node_memory_reader · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._
