https://github.com/rowellx68/valid-nhsnum
Validate NHS Numbers using the 11 modulo method. You can also generate NHS Numbers for testing.
https://github.com/rowellx68/valid-nhsnum
nhs nhs-number testing validation
Last synced: 4 months ago
JSON representation
Validate NHS Numbers using the 11 modulo method. You can also generate NHS Numbers for testing.
- Host: GitHub
- URL: https://github.com/rowellx68/valid-nhsnum
- Owner: rowellx68
- License: mit
- Created: 2021-08-18T19:30:57.000Z (almost 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-11T06:11:37.000Z (10 months ago)
- Last Synced: 2025-09-14T06:29:31.552Z (10 months ago)
- Topics: nhs, nhs-number, testing, validation
- Language: TypeScript
- Homepage: https://rowellx68.github.io/valid-nhsnum/
- Size: 1.07 MB
- Stars: 3
- Watchers: 2
- Forks: 1
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# valid-nhsnum
A zero dependency NHS Number validator and generator.
## Demo
Try the demo [here](https://rowellx68.github.io/valid-nhsnum/).
## Installation
```bash
pnpm i valid-nhsnum
```
## API
#### `validate(value: string): boolean`
This method accepts a string and returns a boolean signifying the value's validity.
```ts
import { validate } from 'valid-nhsnum';
// true
validate('098 357 6548');
```
#### `generate(count: number, formatted?: boolean): string[]`
This method is useful for generating a list of NHS numbers that can be used for testing.
It has an optional boolean parameter that pre-formats the NHS numbers if `true` is passed in.
```ts
import { generate } from 'valid-nhsnum';
// ['035 469 6505', '082 379 5578']
generate(2, true);
// ['0354696505', '0823795578']
generate(2);
```
#### `generateOne(formatted?: boolean): string`
This method generates a single NHS number with an optional boolean parameter that if set to `true` would format the string.
```ts
import { generateOne } from 'valid-nhsnum';
// '082 379 5578'
generateOne(true);
// '0823795578'
generateOne();
```
## Links
- [NHS number format](https://en.wikipedia.org/wiki/NHS_number#Format)
- [What is an NHS number?](https://www.nhs.uk/using-the-nhs/about-the-nhs/what-is-an-nhs-number/)