microsoft-capitalize

1.0.5 • Public • Published

microsoft-capitalize


microsoft-capitalize

Last version Build Status Coverage Status Bundlephobia NPM Status

Sentence-style capitalization in titles and headings based on Microsoft Styleguide.

  • Capitalize the first word of a sentence.
  • Be possible to omit specific exceptions.
  • Use lowercase for everything else.

Install

$ npm install microsoft-capitalize --save

Usage

const capitalize = require('microsoft-capitalize')

capitalize('Microlink CDN: Global Edge Cache')
// => 'Microlink CDN: Global edge cache'

// handling dot corner cases
capitalize('autopilot 2.5')
// => 'Autopilot 2.5'

// passing exceptions
capitalize('JSON+LD & oEmbed', ['oEmbed'])
// => 'JSON+LD & oEmbed'

API

capitalize(input, [exceptions])

input

Required
Type: string

The input string to be capitalize.

exceptions

Type: string[]

A list of words to be excluded.

License

microsoft-capitalize © Kiko Beats, released under the MIT License.
Authored and maintained by Kiko Beats with help from contributors.

kikobeats.com · GitHub Kiko Beats · Twitter @Kikobeats

Package Sidebar

Install

npm i microsoft-capitalize

Weekly Downloads

25,479

Version

1.0.5

License

MIT

Unpacked Size

8.56 kB

Total Files

5

Last publish

Collaborators

  • kikobeats