readline-reverse's Introduction

readline-reverse

📑 Readline reversely in nodejs.

Feature

✔︎ Easy to use.
✔︎ Clear source code.
✔︎ Test coverage: 100%.
✔︎ Options for optimize.
✔︎ Options for security.
✔︎ Supports typescript.

Install

npm install readline-reverse

Rrequire Node.js >= 8.0.0

How to use

const ReadlineReverse = require('readline-reverse')
// init
const reader = new ReadlineReverse()
// open file
await reader.open('/path/to/your/file')
// read n lines reversely
const lastThreeLine = await reader.read(3)
// close file
await reader.close()

Api

constructor(options = {})

Param	Type	Default	Description
`options`	`object`	`{}`	options
`options.flags`	`string`	`r`	open file with flag
`options.separator`	`string`	`\n`	line separator
`options.encoding`	`string`	`utf8`	read file with encoding
`options.bufferSize`	`string`	`4096`	read buffer size, better bigger than average size of one line
`options.maxLineLength`	`number`	`0`	max line length, will throw error when exceed, 0 represent unlimited

open(filepath)

Param	Type	Default	Description
`filepath`	`string`		path of the file your want to read

read(line = 1) ⇒ string[]

Param	Type	Default	Description
`line`	`number`	`1`	number of lines

close()

Param	Type	Default	Description
none

License

MIT License

Copyright (c) 2018 Baffin Lee

Permission is hereby granted, free of charge, to any person obtaining a copy
of this software and associated documentation files (the "Software"), to deal
in the Software without restriction, including without limitation the rights
to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
copies of the Software, and to permit persons to whom the Software is
furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all
copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
SOFTWARE.

readline-reverse's People

Stargazers

Watchers

readline-reverse's Issues

Small bug

Hey,
Thanks for the code. I ran into a bug that triggers when the last READ_TRUNK call doesn't have a new line.

// Original
const { bytesRead } = await read(this[FD], this[BUFFER], 0, this[BUFFER].length, Math.max(position, 0))

FIX 
const { bytesRead } = await read(
  this[FD],
  this[BUFFER],
  0,
  Math.min(this[BUFFER].length, this[FILE_POSITION] + 1), // This argument makes the read call only read whats needed
  Math.max(position, 0)
)

I have a file that can trigger the bug but I don't think there's a way to send attachments

Recommend Projects