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 16+), install with npm:
npm install nlcst-normalize
In Deno with esm.sh
:
import {normalize} from 'https://esm.sh/nlcst-normalize@4'
In browsers with esm.sh
:
<script type="module">
import {normalize} from 'https://esm.sh/nlcst-normalize@4?bundle'
</script>
Use
import {normalize} from 'nlcst-normalize'
normalize("Don't")
normalize('Don’t')
normalize('Don’t', {allowApostrophes: true})
normalize('Block-level')
normalize('Block-level', {allowDashes: true})
normalize({
type: 'WordNode',
children: [
{type: 'TextNode', value: 'Block'},
{type: 'PunctuationNode', value: '-'},
{type: 'TextNode', value: 'level'}
]
})
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
Returns
Normalized word (string
).
Options
Configuration (TypeScript type).
Fields
allowApostrophes
(boolean
, default: false
)
— do not strip apostrophes ('
); the default is to remove apostrophesallowDashes
(boolean
, default: false
)
— Do not strip hyphens (-
); 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 maintained
versions of Node.js.
When we cut a new major release, we drop support for unmaintained versions of
Node.
This means we try to keep the current release line, nlcst-normalize@^4
,
compatible with Node.js 16.
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