{"bugs":{"url":"https://github.com/twolfson/char-props/issues"},"dist":{"shasum":"3120b56aa0770508f47da1b049fd031b91bfda20","tarball":"https://registry.npmjs.org/char-props/-/char-props-0.1.1.tgz","integrity":"sha512-EpYVtCYuaPX0FpJ6QU78mad+G5MPYh21C5XYSiC03v7LId7EuHBFv+OUeWmUD/5Y95oq6xSxVFNUco3sO17G8g==","signatures":[{"sig":"MEUCIGY6TEFyuRoMznEXd0NqFJttEQdV0pIdcQ+l7W6UNS35AiEAxAeljLPnXZbD9mab9pPkufBrXSztJ9rUsGI3GPIwkDA=","keyid":"SHA256:jl3bwswu80PjjokCgh0o2w5c2U4LhQAE57gj9cz1kzA"}]},"main":"lib/charProps","name":"char-props","author":{"url":"http://twolfson.com/","name":"Todd Wolfson","email":"todd@twolfson.com"},"readme":"# char-props\n\nRetrieve line and column of a character at a given index.\n\n## Getting Started\nInstall the module with: `npm install charProps`\n\n## Documentation\n```js\n// charProps is a function which invokes the Indexer constructor\n\n// Indexer JSDoc\n/**\n * Indexer constructor (takes index and performs pre-emptive caching)\n * @constructor\n * @param {String} input Content to index\n */\n\n// Indexer.lineAt JSDoc\n/**\n * Get the line of the character at a certain index\n * @param {Number} index Index of character to retrieve line of\n * @param {Object} [options] Options to use for search\n * @param {Number} [options.minLine=0] Minimum line for us to search on\n * TODO: The following still have to be built/implemented\n * @param {Number} [options.maxLine=lines.length] Maximum line for us to search on\n * @param {String} [options.guess=\"average\"] Affects searching pattern -- can be \"high\", \"low\", or \"average\" (linear top-down, linear bottom-up, or binary)\n * @returns {Number} Line number of character\n */\n\n// Indexer.columnAt JSDoc\n/**\n * Get the column of the character at a certain index\n * @param {Number} index Index of character to retrieve column of\n * @returns {Number} Column number of character\n */\n\n// Indexer.indexAt JSDoc\n/**\n * Get the index of the character at a line and column\n * @param {Object} params Object containing line and column\n * @param {Number} params.line Line of character\n * @param {Number} params.column Column of character\n * @returns {Number} Index of character\n */\n\n// Indexer.charAt JSDoc\n/**\n * Get the character at a line and column\n * @param {Object} params Object containing line and column\n * @param {Number} params.line Line of character\n * @param {Number} params.column Column of character\n * @returns {String} Character at specified location\n */\n```\n\n## Examples\n_(Coming soon)_\n\nFor now, please refer to [tests](/blob/master/test/charProps_test.js).\n\n## Contributing\nIn lieu of a formal styleguide, take care to maintain the existing coding style. Add unit tests for any new or changed functionality. Lint your code via [grunt](http://gruntjs.com/) and test via [vows](http://vowsjs.org/).\n\n## License\nCopyright (c) 2012 Todd Wolfson\nLicensed under the MIT license.\n","engines":{"node":">= 0.6.0"},"scripts":{"test":"vows test/* --spec"},"homepage":"https://github.com/twolfson/char-props","keywords":[],"licenses":[{"url":"https://github.com/twolfson/char-props/blob/master/LICENSE-MIT","type":"MIT"}],"repository":{"url":"git://github.com/twolfson/char-props.git","type":"git"},"description":"Retrieve line and column of a character at a given index.","maintainers":[{"name":"twolfson","email":"todd@twolfson.com"}],"devDependencies":{"vows":"~0.6.4","grunt":"~0.3.12"},"_id":"char-props@0.1.1","version":"0.1.1"}