nlcst-normalize
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 12.20+, 14.14+, 16.0+, 18.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 (string
, Node
, Array<Node>
) for easier comparison. Always normalizes smart apostrophes (’
) to straight apostrophes ('
) and lowercases alphabetical characters ([A-Z]
).
options
Configuration (optional).
options.allowApostrophes
Do not strip apostrophes ('
) (boolean
, default: false
).
options.allowDashes
Do not strip hyphens (-
) (boolean
, default: false
).
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 12.20+, 14.14+, 16.0+, and 18.0+. Our projects sometimes work with older versions, but this is not guaranteed.
Related
nlcst-is-literal
— check whether a node is meant literallynlcst-search
— search for patterns
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.