# memory-pager

> Access memory using small fixed sized buffers

Latest version **1.5.0** (published 2019-01-09) · MIT license · 0 weekly downloads

## Install

```sh
npm install memory-pager
pnpm add memory-pager
yarn add memory-pager
bun add memory-pager
```

## Health

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

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

Warnings: low downloads; no esm support.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 1.5.0 |
| Published | 2019-01-09 |
| First published | 2017-03-03 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | separate (@types/memory-pager) |
| Module format | CommonJS |
| Dependencies | 0 |
| Unpacked size | 7.9 KB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 32 |
| Author | Mathias Buus |
| Maintainers | mafintosh |

## Links

- npm: https://www.npmjs.com/package/memory-pager
- Repository: https://github.com/mafintosh/memory-pager
- Issues: https://github.com/mafintosh/memory-pager/issues
- npm.io page: https://npm.io/package/memory-pager

## Recent versions

- 1.5.0 (latest) — 2019-01-09
- 1.4.0 — 2018-12-21
- 1.3.1 — 2018-12-10
- 1.3.0 — 2018-12-10
- 1.2.0 — 2018-12-09
- 1.1.0 — 2017-10-22
- 1.0.3 — 2017-03-03
- 1.0.2 — 2017-03-03
- 1.0.1 — 2017-03-03
- 1.0.0 — 2017-03-03

## README

# memory-pager

Access memory using small fixed sized buffers instead of allocating a huge buffer.
Useful if you are implementing sparse data structures (such as large bitfield).

![travis](https://travis-ci.org/mafintosh/memory-pager.svg?branch=master)

```
npm install memory-pager
```

## Usage

``` js
var pager = require('paged-memory')

var pages = pager(1024) // use 1kb per page

var page = pages.get(10) // get page #10

console.log(page.offset) // 10240
console.log(page.buffer) // a blank 1kb buffer
```

## API

#### `var pages = pager(pageSize)`

Create a new pager. `pageSize` defaults to `1024`.

#### `var page = pages.get(pageNumber, [noAllocate])`

Get a page. The page will be allocated at first access.

Optionally you can set the `noAllocate` flag which will make the
method return undefined if no page has been allocated already

A page looks like this

``` js
{
  offset: byteOffset,
  buffer: bufferWithPageSize
}
```

#### `pages.set(pageNumber, buffer)`

Explicitly set the buffer for a page.

#### `pages.updated(page)`

Mark a page as updated.

#### `pages.lastUpdate()`

Get the last page that was updated.

#### `var buf = pages.toBuffer()`

Concat all pages allocated pages into a single buffer

## License

MIT

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