UNPKG

nhs-validation/README.md

Version:

496 BMarkdownView Raw

1# NHS-Numbers
2
3Please note that this is in very early stages.
4
5Looking to document this out more in the near future and provide expanded functionality.
6
7Current basic usage is as follows.
8
9```js
10import { NHSNumber } from 'nhs-validation'
11
12const nhsNumber = NHSNumber.generate();
13
14console.log('Is valid? ', NHSNumber.validate(nhsNumber) ); // true
15console.log('Is valid? ', NHSNumber.validate('671 668 9966') ); // true
16console.log('Is valid? ', NHSNumber.validate('000 000 0001') ); // false
17```

1	`# NHS-Numbers`
2
3	`Please note that this is in very early stages.`
4
5	`Looking to document this out more in the near future and provide expanded functionality.`
6
7	`Current basic usage is as follows.`
8
9	```js
10	`import { NHSNumber } from 'nhs-validation'`
11
12	`const nhsNumber = NHSNumber.generate();`
13
14	`console.log('Is valid? ', NHSNumber.validate(nhsNumber) ); // true`
15	`console.log('Is valid? ', NHSNumber.validate('671 668 9966') ); // true`
16	`console.log('Is valid? ', NHSNumber.validate('000 000 0001') ); // false`
17	```