blob: aed176140ca3a3d6ca2d73128a588600b3240299 (
plain) (
blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
|
# 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).
```
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
|
