cno-read-by-block v0.0.2

cno-read-by-block

Micropackage: use NodeJS's promise API to asynchronously read a file by its optimal blocksize.

Table of Contents

• Background
• Install
• Usage
• API
• Contributing
• License

Background

Install

Available on the npm registry as cno-read-by-block. Adding it to project using pnpm:

pnpm add --save cno-read-by-block

It can, of course, also be installed by npm or yarn using the normal methods.

Usage

import ReadByBlock from 'cno-read-by-block'; // Default export is a full "namespace".
import { ReadByBlockFromOptions } from 'cno-read-by-block'; // Just one function.

API

See API.md for full API.

Contributing

Changes are tracked in CHANGELOG.md.

License

MIT ©2024 Anadian

SEE LICENSE IN LICENSE

This project's documentation is licensed under a Creative Commons Attribution-ShareAlike 4.0 International License.