https://github.com/backtrace-labs/node-source-scan
Extract a part of a file based on start and end line numbers.
https://github.com/backtrace-labs/node-source-scan
Last synced: 9 months ago
JSON representation
Extract a part of a file based on start and end line numbers.
- Host: GitHub
- URL: https://github.com/backtrace-labs/node-source-scan
- Owner: backtrace-labs
- Created: 2016-11-10T20:18:55.000Z (about 9 years ago)
- Default Branch: master
- Last Pushed: 2016-11-10T21:01:36.000Z (about 9 years ago)
- Last Synced: 2024-04-26T10:45:50.151Z (over 1 year ago)
- Language: JavaScript
- Size: 3.91 KB
- Stars: 0
- Watchers: 19
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# node-source-scan
Extract a part of a file based on start and end line numbers.
## Usage
```js
var scanFile = require('source-scan').scanFile;
var options = {
filePath: "file.js",
startLine: 100,
endLine: 200,
};
scanFile(options, function(err, sourceBuffer) {
if (err) throw err;
// sourceBuffer is a Buffer object with the source code from lines 100-200.
});
```
## Documentation
### scanFile(options, callback)
`options`:
* `filePath`: String or buffer that represents the file system path to open.
* `startLine`: 0-based line index to start capturing from. 0 is the first line
in the file.
* `endLine`: 0-based line index to stop capturing. `startLine` of 0 and
`endLine`: of 10 means to capture the first 10 lines. If `endLine` is beyond
the end of the file, it is clamped to include the last line.
* `maxByteCount`: optional. Sets a limit on the maximum number of bytes that
will be obtained from the file. Defaults to 120 bytes times
`endLine - startLine`.
`callback(err, sourceBuffer)`