parse-mentions v1.0.0
parse-mentions 
Parse and optionally replace @ mentions from a string of text.
Install
Install with npm:
$ npm install --save parse-mentionsInstall with yarn:
$ yarn add parse-mentionsUsage
var parse = require('parse-mentions');API
.parse
Parses a string and returns an array of @mention objects.
Params
str{String}: Input string to parse looking for @ mentions.fn{Function}: Optional replace function. When passed in, the @ mentions are replaced in the string instead of returned as an array. The new string is returned.returns{String|Array}: Array of mention objects, withnameandmatcharguments.
Example
var mentions = parseMentions('Foo @doowb bar @jonschlinkert');About
Contributing
Pull requests and stars are always welcome. For bugs and feature requests, please create an issue.
Please read the contributing guide for advice on opening issues, pull requests, and coding standards.
Contributors
| Commits | Contributor |
|---|---|
| 13 | doowb |
| 4 | jonschlinkert |
Building docs
(This project's readme.md is generated by verb, please don't edit the readme directly. Any changes to the readme must be made in the .verb.md readme template.)
To generate the readme, run the following command:
$ npm install -g verbose/verb#dev verb-generate-readme && verbRunning tests
Running and reviewing unit tests is a great way to get familiarized with a library and its API. You can install dependencies and run tests with the following command:
$ npm install && npm testAuthor
Brian Woodward
License
Copyright © 2017, Brian Woodward. Released under the MIT License.
This file was generated by verb-generate-readme, v0.6.0, on June 30, 2017.