https://github.com/gkucmierz/social-links
Validate & sanitize social links
https://github.com/gkucmierz/social-links
Last synced: about 2 months ago
JSON representation
Validate & sanitize social links
- Host: GitHub
- URL: https://github.com/gkucmierz/social-links
- Owner: gkucmierz
- License: mit
- Created: 2020-07-08T12:00:45.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-02-05T03:54:23.000Z (4 months ago)
- Last Synced: 2025-03-29T20:08:13.838Z (2 months ago)
- Language: TypeScript
- Homepage: https://npmjs.com/package/social-links
- Size: 901 KB
- Stars: 29
- Watchers: 1
- Forks: 14
- Open Issues: 11
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
README
    [](https://github.com/gkucmierz/social-links/actions/workflows/npm-publish.yml)
# Social Links
Social Links is helping to detect, validate and sanitize social (desktop & mobile) links
### Install
```bash
npm i social-links --save
```
### Demo
- https://awesome-web-tools.web.app/social-links - Example use case
- https://gkucmierz.github.io/social-links-app - Detect profile demo (v1.7.0)
### Using
```js
import { SocialLinks, TYPE_MOBILE } from 'social-links';
const socialLinks = new SocialLinks();
const link = 'http://www.linkedin.com/in/gkucmierz';
const profileName = socialLinks.detectProfile(link); // 'linkedin'
console.log(socialLinks.isValid(profileName, link)); // true
console.log(socialLinks.sanitize(profileName, link)); // 'https://linkedin.com/in/gkucmierz'
console.log(socialLinks.sanitize(profileName, link, TYPE_MOBILE)); // 'https://linkedin.com/mwlite/in/gkucmierz'
```
Above examples works based on predefined **linkedin** profile:
```js
import { Profile } from 'social-links';
const linkedinProfile: Profile =
{ name: 'linkedin',
matches: [
{
match: '(https?://)?(www.)?linkedin.com/in/({PROFILE_ID})', group: 3, type: TYPE_DESKTOP,
pattern: 'https://linkedin.com/in/{PROFILE_ID}'
},
{
match: '(https?://)?(www.)?linkedin.com/mwlite/in/({PROFILE_ID})', group: 3, type: TYPE_MOBILE,
pattern: 'https://linkedin.com/mwlite/in/{PROFILE_ID}'
},
{ match: '({PROFILE_ID})', group: 1 },
]
};
```
### Add new profile
```js
import { SocialLinks, Profile } from 'social-links';
const socialLinks = new SocialLinks();
const profileMatches: ProfileMatch[] = [ ... ];
socialLinks.addProfile('profileName', profileMatches);
```
### Configuration
```js
import { SocialLinks, Config } from 'social-links';
const config: Config = {
usePredefinedProfiles: true,
trimInput: true,
allowQueryParams: false,
};
const socialLinks = new SocialLinks(config);
```
### Build
Watch, *tsc* build
```bash
npm run start
```
### Tests
Just *jest* tests
```bash
npm run test
```
or
```bash
npm run test:watch
```
### Contributing
[CONTRIBUTING.md](CONTRIBUTING.md)