https://github.com/ilib-js/ilib-ctype
CType (character type) functions based on the Unicode Character Database
https://github.com/ilib-js/ilib-ctype
Last synced: about 1 month ago
JSON representation
CType (character type) functions based on the Unicode Character Database
- Host: GitHub
- URL: https://github.com/ilib-js/ilib-ctype
- Owner: iLib-js
- License: apache-2.0
- Created: 2021-04-24T22:03:47.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2024-01-25T16:19:55.000Z (over 2 years ago)
- Last Synced: 2024-04-25T09:02:24.043Z (about 2 years ago)
- Language: JavaScript
- Size: 171 KB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
> :warning: **Deprecation Notice** :warning:
> This repository has been deprecated. Please use the corresponding package from the [iLib-js monorepo](https://github.com/iLib-js/ilib-mono) instead.
# ilib-common
Various utility classes for the ilib packages.
## Installation
```
npm install ilib-ctype
or
yarn add ilib-ctype
```
## CType Functions
The CType functions are modeled after the posix ctype functions for C/C++.
The data for all of the CType functions are derived from the Unicode
Character Database so that they can be called with any character in
Unicode. (Many posix implementations do not support Unicode!)
Because Javascript does not have an intrinsic character type, the arguments
for these functions are strings. Only the very first character in the
string is examined to determine the output of the function. The rest of
the string is ignored.
The functions are as follows:
- isAlnum - is the character alpha numeric?
- isAlpha - is the character alphabetic?
- isAscii - is the character part of the ASCII subset?
- isBlank - is the character blank?
- isCntrl - is the character a control character?
- isDigit - is the character a digit?
- isGraph - is the character a graphic character?
- isIdeo - is the character an ideographic (Asian) character?
- isLower - is the character lower-case? For scripts that do not have
the concept of cases, this always returns true.
- isPrint - is the character printable on the screen?
- isPunct - is the character a punctuation character?
- isScript - does the given character belong to the named script?
- isSpace - is the character a whitespace character?
- isUpper - is the character upper-case? For scripts that do not have
the concept of case, this always returns true.
- isXdigit - is this character a hexadecimal digit?
Additionally, there is a `withinRange()` function which returns
true if the given character is within the named Unicode range.
```javascript
import { withinRange } from 'ilib-ctype';
console.log(withinRange("\uFE2A", "HalfMarks")); // prints true
```
## Using the CType Functions
All of the functions are exported from the package in general. Here is
an example of how you would use the `isAlpha` function.
```javascript
import { isAlpha } from "ilib-ctype";
console.log(isAlpha("a")); // prints true
console.log(isAlpha("3")); // prints false
```
If you are using this package in a webpack bundle, make sure to
only import the ctype functions you need in order to minimize
the final size of your bundle. That is, do not `import *` as that
will bring in a bunch of data that you probably don't need. Tree
shaking in the latest webpack will ensure that only the data needed
for the functions you are using will be included in your bundle.
## License
Copyright © 2021-2024, JEDLSoft
Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at
http://www.apache.org/licenses/LICENSE-2.0
Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
## Release Notes
### v1.2.1
- updated dependencies
- converted all unit tests from nodeunit to jest
### v1.2.0
- update to UCD 15.1.0
### v1.1.0
- made this package into a true hybrid package that supports both
commonjs and ESM
### v1.0.0
- initial version
- copied from ilib 14.8.0