JSPM

get-line-from-pos

1.0.0
  • ESM via JSPM
  • ES Module Entrypoint
  • Export Map
  • Keywords
  • License
  • Repository URL
  • TypeScript Types
  • README
  • Created
  • Published
  • Downloads 1623
  • Score
    100M100P100Q101270F
  • License MIT

Get the line number of a string using index or position

Package Exports

  • get-line-from-pos

This package does not declare an exports field, so the exports above have been automatically detected and optimized by JSPM instead. If any package subpath is missing, it is recommended to post an issue to the original package (get-line-from-pos) to support the "exports" field. If that is not possible, create a JSPM override to customize the exports field for this package.

Readme

get-line-from-pos

Get the line number of a string using index or position

NPM Version NPM Downloads Build Status

Lookup a line number in a string using an index or position.

Useful if you want to get a line number of a position or index from a regex match, but can also be used in other situations.

  • Allows using negative positions to lookup line number.
  • Supported by CommonJS, AMD and browser.
  • Supports Regular line ending style (\n) and MacOS line ending style (\r).

Installation

$ npm install --save get-line-from-pos

Usage

CommonJS

var getLineFromPos = require('get-line-from-pos');

var str = 'string with \n multiple \n lines';
console.log(getLineFromPos(str, /multiple/g.exec(str)));
// -> 2

AMD

define(['getLineFromPos'], function(getLineFromPos){
    var pos = getLineFromPos(multipleLineStr, index);
    console.log(pos);
    //-> line number that index is on
});

Browser

Load the script:

<script src="../get-line-from-pos/index.js"></script>

Then when you need to use it:

console.log(getLineFromPos(someStr, -1));
//-> Will output the number of lines in someStr

API

getLineFromPos(inputStr, index)

Both parameters are required.

inputStr

Type: String

Required

String to do the lookup for line number.

index

Type: Number

Required

The index or position to lookup the line number.

License

Copyright © 2014 Gilad Peleg. Licensed under the MIT license.