ap-style-title-case
TypeScript icon, indicating that this package has built-in type declarations

2.0.0 • Public • Published

ap-style-title-case

Build Coverage Downloads Size

Convert a value to AP/APA title case.

Contents

What is this?

This small package turns a sentence into title case.

When should I use this?

You can use this when you have short text of unknown casing and want to display it in a heading or so.

Install

This package is ESM only. In Node.js (version 14.14+, 16.0+), install with npm:

npm install ap-style-title-case

In Deno with esm.sh:

import {apStyleTitleCase} from 'https://esm.sh/ap-style-title-case@2'

In browsers with esm.sh:

<script type="module">
  import {apStyleTitleCase} from 'https://esm.sh/ap-style-title-case@2?bundle'
</script>

Use

import {apStyleTitleCase} from 'ap-style-title-case'

console.log(apStyleTitleCase('why sunless tanning is A hot trend'))
// 'Why Sunless Tanning Is a Hot Trend'

API

apStyleTitleCase(value[, options])

Convert a value (string) to title case (string) using AP/APA style.

options

Configuration (optional).

options.keepSpaces

Keep superfluous whitespace (boolean, default: false). Whitespace is turned into a space by default.

options.stopwords

List of stopwords (Array<string>, default: see below). When a lowercased word is included in this list, it will be used as lowercase. Otherwise words are capitalized.

Algorithm

  • always capitalize the first word, even if it’s a stop word
  • always capitalize the last word, even if it’s a stop word
  • lowercase these words: a, an, and, at, but, by, for, in, nor, of, on, or, so, the, to, up, yet

Many writers make the error of leaving to be verbs in lower case. Even though is, are, was, and be, are all short words, they should still be capitalized in a title because they are verbs.

When you write titles that contain prepositions, your word processor will likely tell you that you should leave words like with, about, and around lowercase. Defiantly look past the squiggly line indicating a potential error, and remember that in AP title case, prepositions with four or more letters should be capitalized.

These rules are the exact same for APA style, the only difference being that AP style does not recommend the use of title case for newspaper headlines, but rather sentence case.

References

Types

This package is fully typed with TypeScript. It exports the additional type Options.

Compatibility

This package is at least compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. It also works in Deno and modern browsers.

Contribute

Yes please! See How to Contribute to Open Source.

Security

This package is safe.

License

MIT © Zeke Sikelianos

Package Sidebar

Install

npm i ap-style-title-case

Weekly Downloads

13,819

Version

2.0.0

License

MIT

Unpacked Size

10 kB

Total Files

5

Last publish

Collaborators

  • wooorm
  • zeke