Huge News!Announcing our $40M Series B led by Abstract Ventures.Learn More
Socket
Sign inDemoInstall
Socket

collect-mentions

Package Overview
Dependencies
Maintainers
0
Versions
7
Alerts
File Explorer

Advanced tools

Socket logo

Install Socket

Detect and block malicious and high-risk dependencies

Install

collect-mentions

  • 2.0.1
  • latest
  • npm
  • Socket score

Version published
Maintainers
0
Created
Source

collect-mentions npm version License Libera Manifesto

Code style bunning Make A Pull Request Time Since Last Commit

Collect mentions from a given text string, using battle-tested mentions-regex package

If you have any how-to kind of questions, please read the Contributing Guide and Code of Conduct documents.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Conventional Commits PayPal Author Support Share Love Tweet NPM Downloads Weekly NPM Downloads Monthly NPM Downloads Total

Table of Contents

Install

This project requires Node.js >=20. Install it using yarn or npm.
We highly recommend to use Yarn when you think to contribute to this project.

$ yarn add collect-mentions

API

collectMentions

Collect all mentions from string. Returns array of objects with properties { handle, mention, index }.

Params

  • str {String}: string to collect mentions from
  • dot {Boolean}: if it is true, it will support mentions including dot
  • returns {Array}: array of objects

Example

import collectMentions from 'collect-mentions';

const mentions = collectMentions('foo @tunnckoCore and yeah @bar, right?');

console.log(mentions);
// => [
//   { handle: '@tunnckoCore', mention: 'tunnckoCore', index: 3 },
//   { handle: '@bar', mention: 'bar', index: 25 },
// ]

// If `dot` boolean is `true`
console.log(collectMentions('some @ok.bar yeah', true));
// => [{ handle: '@ok.bar', mention: 'ok.bar', index: 4 }]

back to top

Some of these projects are used here or were inspiration for this one, others are just related. So, thanks for your existance!

  • asia: Blazingly fast, magical and minimalist testing framework, for Today and Tomorrow | homepage
  • charlike: Small, fast, simple and streaming project scaffolder for myself, but not… more | homepage
  • gitcommit: Lightweight and joyful git commit replacement. Conventional Commits compliant. | homepage
  • new-release: A stable alternative to semantic-release. Only handles NPM publishing and nothing… more | homepage
  • xaxa: Zero-config linting, powered by few amazing unicorns, AirBnB & Prettier. | homepage

back to top

Contributing

Please read the Contributing Guide and Code of Conduct documents for advices.
For bugs reports and feature requests, please create an issue or ping @tunnckoCore at Twitter.

Contributors

Thanks to the hard work of these wonderful people this project is alive and it also follows the all-contributors specification.
Pull requests, stars and all kind of contributions are always welcome. :stars:

Users

You can see who uses collect-mentions in the USERS.md file. Please feel free adding this file if it not exists.
If you or your organization are using this project, consider adding yourself to the list of users.
Thank You! :heart:

License

Copyright (c) 2017-present, Charlike Mike Reagent.
Released under the Apache-2.0 License.


This file was generated by verb-generate-readme, v0.7.0, on July 25, 2018.

FAQs

Package last updated on 21 Oct 2024

Did you know?

Socket

Socket for GitHub automatically highlights issues in each pull request and monitors the health of all your open source dependencies. Discover the contents of your packages and block harmful activity before you install or update your dependencies.

Install

Related posts

SocketSocket SOC 2 Logo

Product

  • Package Alerts
  • Integrations
  • Docs
  • Pricing
  • FAQ
  • Roadmap
  • Changelog

Packages

npm

Stay in touch

Get open source security insights delivered straight into your inbox.


  • Terms
  • Privacy
  • Security

Made with ⚡️ by Socket Inc