Security News
tea.xyz Spam Plagues npm and RubyGems Package Registries
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
url-slug
Advanced tools
Readme
npm install url-slug
import urlSlug from 'url-slug'
urlSlug('Sir James Paul McCartney MBE is an English singer-songwriter')
// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
⚠️ Only named exports are available in Node.js.
import { convert } from 'url-slug'
urlSlug('Sir James Paul McCartney MBE is an English singer-songwriter')
// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
const { convert } = require('url-slug')
urlSlug('Sir James Paul McCartney MBE is an English singer-songwriter')
// sir-james-paul-mc-cartney-mbe-is-an-english-singer-songwriter
Returns value
value converted to a slug.
A string to be slugified.
Name | Description | Default |
---|---|---|
camelCase | Split on camel case occurrences | true |
dictionary | Chars to be replaced | {} |
separator | Character or string used to separate the slug fragments | '-' |
transformer | A built-in transformer or a custom function (null to keep the string unchanged) | LOWERCASE_TRANSFORMER |
import * as urlSlug from 'url-slug'
urlSlug.convert('Comfortably Numb', {
transformer: urlSlug.UPPERCASE_TRANSFORMER,
})
// COMFORTABLY-NUMB
urlSlug.convert('á é í ó ú Á É Í Ó Ú ç Ç ª º ¹ ² ½ ¼', {
separator: '_',
transformer: false,
})
// a_e_i_o_u_A_E_I_O_U_c_C_a_o_1_2_1_2_1_4
urlSlug.convert('Red, red wine, stay close to me…', {
separator: '',
transformer: urlSlug.TITLECASE_TRANSFORMER,
})
// RedRedWineStayCloseToMe
urlSlug.convert('Schwarzweiß', {
dictionary: { ß: 'ss', z: 'z ' },
})
// schwarz-weiss
Returns the value
value converted to a regular sentence.
A slug to be reverted to a sentence.
Name | Description | Default |
---|---|---|
camelCase | Split on camel case occurrences | false |
separator | Character or string to split the slug (null for automatic splitting) | null |
transformer | A built-in transformer or a custom function (null to keep the string unchanged) | false |
import { revert, TITLECASE_TRANSFORMER } from 'url-slug'
revert('Replace-every_separator.allowed~andSplitCamelCaseToo', {
camelCase: true,
})
// Replace every separator allowed and Split Camel Case Too
revert('this-slug-needs-a-title_case', {
separator: '-',
transformer: TITLECASE_TRANSFORMER,
})
// This Slug Needs A Title_case
Custom transformers are expressed by a function that receives two arguments:
fragments
, an array containing the words of a sentence or a slug, and
separator
, which is the separator string set in convert()
options. When
revert()
calls a transformer, the separator
argument will always be a space
character (' '
) — the separator
option will be used to split the slug.
Transformers should always return a string.
import { convert, revert } from 'url-slug'
convert('O’Neill is an American surfboard, surfwear and equipment brand', {
transformer: (fragments) => fragments.join('x').toUpperCase(),
})
// OxNEILLxISxANxAMERICANxSURFBOARDxSURFWEARxANDxEQUIPMENTxBRAND
revert('WEIrd_SNAke_CAse', {
separator: '_',
transformer: (fragments, separator) =>
fragments
.map(
(fragment) =>
fragment.slice(0, -2).toLowerCase() + fragment.slice(-2).toUpperCase()
)
.join(separator),
})
// weiRD snaKE caSE
Converts the result to lowercase. E.g.: // SOME WORDS >> some words
Converts the result to sentence case. E.g.: // sOME WORDS >> Some words
Converts the result to uppercase. E.g.: // some words >> SOME WORDS
Converts the result to title case. E.g.: // sOME wORDS >> Some Words
Any character or an empty string can be used in the separator
property. When
the separator
is an empty string, the revert()
method will split the slug
only on camel case occurrences if camelCase
option is set to true
,
or else it returns an untouched string. The following characters are valid
according to RFC 3986 — defined as unreserved or sub-delims —, and will be
used in revert()
function if automatic splitting is enabled — separator
is
set to null
:
-
, .
, _
, ~
, ^
, -
, .
, _
, ~
, !
, $
, &
, '
, (
, )
, *
,
+
, ,
, ;
or =
dictionary
optionIt must be an object, with keys set as single characters and values as strings of any length:
import { convert } from 'url-slug'
convert('♥øß', {
dictionary: {
'♥': 'love',
ø: 'o',
ß: 'ss',
//...
},
})
// loveoss
To add separators before or after a specific character, add a space before or after the dictionary definition:
import { convert } from 'url-slug'
convert('♥øß', {
dictionary: {
'♥': 'love',
ø: ' o', // A space was added before
ß: 'ss',
//...
},
})
// love-oss
convert('♥øß', {
dictionary: {
'♥': 'love',
ø: ' o ', // A space was added before and after
ß: 'ss',
//...
},
})
// love-o-ss
convert('♥øß', {
dictionary: {
'♥': 'love',
ø: 'o ', // A space was added after
ß: 'ss',
//...
},
})
// loveo-ss
Compatible with any environment with ES6 support.
FAQs
Slug generator with less than 1 KB and no dependencies, RFC 3986 compliant
The npm package url-slug receives a total of 231,879 weekly downloads. As such, url-slug popularity was classified as popular.
We found that url-slug demonstrated a healthy version release cadence and project activity because the last version was released less than a year ago. It has 1 open source maintainer collaborating on the project.
Did you know?
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.
Security News
Tea.xyz, a crypto project aimed at rewarding open source contributions, is once again facing backlash due to an influx of spam packages flooding public package registries.
Security News
As cyber threats become more autonomous, AI-powered defenses are crucial for businesses to stay ahead of attackers who can exploit software vulnerabilities at scale.
Security News
UnitedHealth Group disclosed that the ransomware attack on Change Healthcare compromised protected health information for millions in the U.S., with estimated costs to the company expected to reach $1 billion.