9de94a264c
|
||
|---|---|---|
| .. | ||
| types | ||
| index.js | ||
| license | ||
| package.json | ||
| readme.md | ||
readme.md
vfile-location
Convert between positional (line and column-based) and offsets (range-based) locations in a virtual file.
Install
npm:
npm install vfile-location
Use
var vfile = require('vfile')
var vfileLocation = require('vfile-location')
var location = vfileLocation(vfile('foo\nbar\nbaz'))
var offset = location.toOffset({line: 3, column: 3}) // => 10
location.toPoint(offset) // => {line: 3, column: 3, offset: 10}
API
location = vfileLocation(doc)
Get transform functions for the given doc (string) or file.
Returns an object with toOffset and toPoint.
location.toOffset(point)
Get the offset (number) for a line and column-based point in the
bound file.
Returns -1 when given invalid or out of bounds input.
location.toPoint(offset)
Get the line and column-based point for offset in the bound file.
Contribute
See contributing.md in vfile/.github for ways to
get started.
See support.md for ways to get help.
This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.