npm.io
1.2.0 • Published 10 months ago

index-to-position

Licence
MIT
Version
1.2.0
Deps
0
Size
5 kB
Vulns
0
Weekly
0
Stars
36

index-to-position

Convert a string index to its line and column position

Install

npm install index-to-position

Usage

import indexToPosition from 'index-to-position';

indexToPosition('hello\nworld\n!', 7);
//=> {line: 1, column: 1}

API

indexToPosition(text, index, options?)
text

Type: string

The text in which to find the line and column position.

index

Type: number

The index in the string for which to find the line and column position.

options

Type: object

oneBased

Type: boolean
Default: false

Whether to use 1-based or 0-based indexing for the result.

oneBasedLine

Type: boolean
Default: false

Whether to use 1-based or 0-based line indexing for the result.

oneBasedColumn

Type: boolean
Default: false

Whether to use 1-based or 0-based column indexing for the result.

Keywords