1 Star 0 Fork 0

i8gua / firstline

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
MIT

Firstline

Travis David npm

Introduction

Firstline is a npm async module for NodeJS, that reads and returns the first line of any file. It uses native JS promises and streams (requires Node >= v4.0.0). It is well tested and built for high performance.

It is particularly suited when you need to programmatically access the first line of a large amount of files, while handling errors if they occur.

Install

npm install firstline

(add "--save" if you want the module to be automatically added to your project's "package.json" dependencies)

var firstline = require(firstline)

API

firstline(filepath)

Incrementally reads data from "filepath" until it reaches the end of the first line. Returns a promise, eventually fulfilled with a string.

// Imagine the file content is:
// abc
// def
// ghi
//

firstline('./my-file.txt')
// -> Returns a promise that will be fulfilled with: 'abc'

MIT License

The MIT License (MIT) Copyright (c) 2015 Alessandro Zanardi 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.

简介

暂无描述 展开 收起
MIT
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
1
https://gitee.com/i8gua/firstline.git
git@gitee.com:i8gua/firstline.git
i8gua
firstline
firstline
master

搜索帮助