Skip to content

Latest commit

 

History

History
63 lines (41 loc) · 1.29 KB

check.md

File metadata and controls

63 lines (41 loc) · 1.29 KB

check

Test whether a string matches a character class.

API

Numeric.string.check(input, category = 'alnum')

Matches each string against a named validation pattern.

  • Parameters:
    • input: String or array of strings to test
    • category: Character class used for the validation
  • Returns: Match results matching the input shape
  • NumPy: Covers np.strings.isalnum, np.strings.isalpha, np.strings.isdecimal, np.strings.isdigit, np.strings.islower, np.strings.isnumeric, np.strings.isspace, np.strings.istitle, np.strings.isupper, np.char.isalnum through np.char.isupper via a single Numerix method.

Examples

Test alphanumeric characters

import Numeric from '@neabyte/numerix'

const flag = Numeric.string.check('abc123', 'alnum')

console.log(flag)
// true

Test alphabetic characters

import Numeric from '@neabyte/numerix'

const flag = Numeric.string.check('abc', 'alpha')

console.log(flag)
// true

Test whitespace characters

import Numeric from '@neabyte/numerix'

const flag = Numeric.string.check('a b', 'space')

console.log(flag)
// false

Test an array of strings

import Numeric from '@neabyte/numerix'

const flags = Numeric.string.check(['abc', 'a1'], 'alpha')

console.log(flags)
// [true,false]