https://github.com/doowb/parse-mentions
Parse and optionally replace @ mentions from a string of text.
https://github.com/doowb/parse-mentions
Last synced: about 1 year ago
JSON representation
Parse and optionally replace @ mentions from a string of text.
- Host: GitHub
- URL: https://github.com/doowb/parse-mentions
- Owner: doowb
- License: mit
- Created: 2016-09-24T18:11:29.000Z (almost 10 years ago)
- Default Branch: master
- Last Pushed: 2017-06-30T05:47:06.000Z (about 9 years ago)
- Last Synced: 2025-05-09T02:13:46.210Z (about 1 year ago)
- Language: JavaScript
- Size: 19.5 KB
- Stars: 6
- Watchers: 2
- Forks: 4
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: .github/contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# parse-mentions [](https://www.npmjs.com/package/parse-mentions) [](https://npmjs.org/package/parse-mentions) [](https://npmjs.org/package/parse-mentions) [](https://travis-ci.org/doowb/parse-mentions) [](https://ci.appveyor.com/project/doowb/parse-mentions)
> Parse and optionally replace @ mentions from a string of text.
## Install
Install with [npm](https://www.npmjs.com/):
```sh
$ npm install --save parse-mentions
```
Install with [yarn](https://yarnpkg.com):
```sh
$ yarn add parse-mentions
```
## Usage
```js
var parse = require('parse-mentions');
```
## API
### [.parse](index.js#L16)
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, with `name` and `match` arguments.
**Example**
```js
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](../../issues/new).
Please read the [contributing guide](.github/contributing.md) for advice on opening issues, pull requests, and coding standards.
### Contributors
| **Commits** | **Contributor** |
| --- | --- |
| 13 | [doowb](https://github.com/doowb) |
| 4 | [jonschlinkert](https://github.com/jonschlinkert) |
### Building docs
_(This project's readme.md is generated by [verb](https://github.com/verbose/verb-generate-readme), please don't edit the readme directly. Any changes to the readme must be made in the [.verb.md](.verb.md) readme template.)_
To generate the readme, run the following command:
```sh
$ npm install -g verbose/verb#dev verb-generate-readme && verb
```
### Running 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:
```sh
$ npm install && npm test
```
### Author
**Brian Woodward**
* [github/doowb](https://github.com/doowb)
* [twitter/doowb](https://twitter.com/doowb)
### License
Copyright © 2017, [Brian Woodward](https://github.com/doowb).
Released under the [MIT License](LICENSE).
***
_This file was generated by [verb-generate-readme](https://github.com/verbose/verb-generate-readme), v0.6.0, on June 30, 2017._