Nevermore: a Poet's Mantra

    nlcst-normalize
    TypeScript icon, indicating that this package has built-in type declarations

    3.1.1 • Public • Published

    nlcst-normalize

    Build Coverage Downloads Size Sponsors Backers Chat

    nlcst utility to normalize a word for easier comparison.

    Contents

    What is this?

    This utility serializes a node and cleans it.

    When should I use this?

    This package is a tiny utility that helps when comparing natural language to word lists.

    Install

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

    npm install nlcst-normalize

    In Deno with esm.sh:

    import {normalize} from 'https://esm.sh/nlcst-normalize@3'

    In browsers with esm.sh:

    <script type="module">
      import {normalize} from 'https://esm.sh/nlcst-normalize@3?bundle'
    </script>

    Use

    import {normalize} from 'nlcst-normalize'
    
    normalize("Don't") // => 'dont'
    normalize('Don’t') // => 'dont'
    normalize('Don’t', {allowApostrophes: true}) // => 'don\'t'
    normalize('Block-level') // => 'blocklevel'
    normalize('Block-level', {allowDashes: true}) // => 'block-level'
    
    normalize({
      type: 'WordNode',
      children: [
        {type: 'TextNode', value: 'Block'},
        {type: 'PunctuationNode', value: '-'},
        {type: 'TextNode', value: 'level'}
      ]
    }) // => 'blocklevel'

    API

    This package exports the identifier normalize. There is no default export.

    normalize(value[, options])

    Normalize a word for easier comparison.

    Always normalizes smart apostrophes () to straight apostrophes (') and lowercases alphabetical characters ([A-Z]).

    Parameters
    • value (string, Node, or Array<Node>) — word
    • options (Options, optional) — configuration
    Returns

    Normalized word (string).

    Options

    Configuration (TypeScript type).

    Fields
    allowApostrophes

    Do not strip apostrophes (') (boolean, default: false).

    The default is to remove apostrophes.

    allowDashes

    Do not strip hyphens (-) (boolean, default: false).

    The default is to remove the hyphen-minus character.

    Types

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

    Compatibility

    Projects maintained by the unified collective are compatible with all maintained versions of Node.js. As of now, that is Node.js 14.14+ and 16.0+. Our projects sometimes work with older versions, but this is not guaranteed.

    Related

    Contribute

    See contributing.md in syntax-tree/.github for ways to get started. See support.md for ways to get help.

    This project has a code of conduct. By interacting with this repository, organization, or community you agree to abide by its terms.

    License

    MIT © Titus Wormer

    Install

    npm i nlcst-normalize

    DownloadsWeekly Downloads

    24,843

    Version

    3.1.1

    License

    MIT

    Unpacked Size

    10.8 kB

    Total Files

    7

    Last publish

    Collaborators

    • wooorm
    • kmck