summaryrefslogtreecommitdiffstats
path: root/node_modules/memory-pager/README.md
diff options
context:
space:
mode:
authorGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
committerGravatar Piotr Russ <mail@pruss.it> 2020-11-18 23:26:45 +0100
commit81ddf9b700bc48a1f8e472209f080f9c1d9a9b09 (patch)
tree8b959d50c5a614cbf9fcb346ed556140374d4b6d /node_modules/memory-pager/README.md
parent1870f3fdf43707a15fda0f609a021f516f45eb63 (diff)
downloadwebsite_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.gz
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.tar.bz2
website_creator-81ddf9b700bc48a1f8e472209f080f9c1d9a9b09.zip
rm node_modules
Diffstat (limited to 'node_modules/memory-pager/README.md')
-rw-r--r--node_modules/memory-pager/README.md65
1 files changed, 0 insertions, 65 deletions
diff --git a/node_modules/memory-pager/README.md b/node_modules/memory-pager/README.md
deleted file mode 100644
index aed1761..0000000
--- a/node_modules/memory-pager/README.md
+++ /dev/null
@@ -1,65 +0,0 @@
-# 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