node/tools/eslint/node_modules/vfile-location

vfile-location

Convert between positions (line and column-based) and offsets (range-based) locations in a virtual file.

Installation

npm:

npm install vfile-location

Usage

var vfile = require('vfile');
var vfileLocation = require('vfile-location');
var location = vfileLocation(vfile('foo\nbar\nbaz'));

var offset = location.toOffset({line: 3, column: 3});
var position = location.toPosition(offset);

Yields:

10
{
  "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 toPosition.

location.toOffset(position)

Get the offset (number) for a line and column-based position in the bound file. Returns -1 when given invalid or out of bounds input.

location.toPosition(offset)

Get the line and column-based position for offset in the bound file.

License

MIT © Titus Wormer