nlcst-types

NLCST types for TypeScript.

Downloads in past

Stats

StarsIssuesVersionUpdatedCreatedSize
nlcst-types
1.4.06 months ago5 years agoMinified + gzip package size for nlcst-types in KB

Readme

nlcst-types
NLCST types for TypeScript.

Install

Install with npm:
npm install nlcst-types

Usage

import {
    Root,
    Paragraph,
    Sentence,
    Word,
    Text,
    Symbol,
    Punctuation,
    WhiteSpace,
    Source,
    TextNode
} from "nlcst-types";
// Type Guard
// https://basarat.gitbooks.io/typescript/docs/types/typeGuard.html
import {
    isRoot,
    isParagraph,
    isSentence,
    isWord,
    isText,
    isSymbol,
    isPunctuation,
    isWhiteSpace,
    isSource,
    isTextNode
} from "nlcst-types";

Changelog

See Releases page.

Running tests

Install devDependencies and Run npm test:
npm i -d && npm test

Contributing

Pull requests and stars are always welcome.
For bugs and feature requests, please create an issue.
  1. Fork it!
  2. Create your feature branch: git checkout -b my-new-feature
  3. Commit your changes: git commit -am 'Add some feature'
  4. Push to the branch: git push origin my-new-feature
  5. Submit a pull request :D

Author

License

MIT © azu