index-to-position's Introduction

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.

index-to-position's People

Contributors

Stargazers

Watchers

index-to-position's Issues

Support `\r` as line break?

Missed or intentionally not to support?

Column returns `NaN` for invalid arguments

When using the indexToPosition function with invalid arguments for the "index" parameter, the "column" value is incorrectly returning NaN. It would be beneficial to review this behavior to enhance error handling and improve clarity for users when utilizing the function.

Code Examples:

console.log(indexToPosition('hello\nworld\n!'));
//=> {line: 2, column: NaN}

console.log(indexToPosition('hello\nworld\n!', 'invalid argument'));
//=> {line: 2, column: NaN}

console.log(indexToPosition('hello\nworld\n!', {}));
//=> {line: 2, column: NaN}