Logo for jsDocs.io

title-case

  • Version 4.3.1
  • Published
  • 16.6 kB
  • No dependencies
  • MIT license

Install

npm i title-case
yarn add title-case
pnpm add title-case

Overview

Transform a string into title case following English rules

Index

Variables

Functions

Interfaces

Variables

variable SENTENCE_TERMINATORS

const SENTENCE_TERMINATORS: Set<string>;

    variable SMALL_WORDS

    const SMALL_WORDS: Set<string>;

      variable TITLE_TERMINATORS

      const TITLE_TERMINATORS: Set<string>;

        variable WORD_SEPARATORS

        const WORD_SEPARATORS: Set<string>;

          Functions

          function titleCase

          titleCase: (input: string, options?: Options | string[] | string) => string;

            Interfaces

            interface Options

            interface Options {}

              property locale

              locale?: string | string[];

                property sentenceCase

                sentenceCase?: boolean;

                  property sentenceTerminators

                  sentenceTerminators?: Set<string>;

                    property smallWords

                    smallWords?: Set<string>;

                      property titleTerminators

                      titleTerminators?: Set<string>;

                        property wordSeparators

                        wordSeparators?: Set<string>;

                          Package Files (1)

                          Dependencies (0)

                          No dependencies.

                          Dev Dependencies (0)

                          No dev dependencies.

                          Peer Dependencies (0)

                          No peer dependencies.

                          Badge

                          To add a badge like this onejsDocs.io badgeto your package's README, use the codes available below.

                          You may also use Shields.io to create a custom badge linking to https://www.jsdocs.io/package/title-case.

                          • Markdown
                            [![jsDocs.io](https://img.shields.io/badge/jsDocs.io-reference-blue)](https://www.jsdocs.io/package/title-case)
                          • HTML
                            <a href="https://www.jsdocs.io/package/title-case"><img src="https://img.shields.io/badge/jsDocs.io-reference-blue" alt="jsDocs.io"></a>