fix(cdc): rename isCitizenDigitalCertificateNumber to isCdcNumber to …

…simplify API call

src/citizen-digital-certificate-number.test.ts

@@ -1,27 +1,23 @@
-import { isCitizenDigitalCertificateNumber } from './citizen-digital-certificate-number'
+import { isCdcNumber } from './citizen-digital-certificate-number'
 
-describe('isCitizenDigitalCertificateNumber', () => {
+describe('isCdcNumber', () => {
  it('should only accept strings with length 16', () => {
- expect(isCitizenDigitalCertificateNumber({} as string)).toBe(false)
- expect(
- isCitizenDigitalCertificateNumber(47809425348791 as unknown as string)
- ).toBe(false)
- expect(
- isCitizenDigitalCertificateNumber(undefined as unknown as string)
- ).toBe(false)
- expect(isCitizenDigitalCertificateNumber('AB123456789012345')).toBe(false)
- expect(isCitizenDigitalCertificateNumber('AB1234567890123')).toBe(false)
+ expect(isCdcNumber({} as string)).toBe(false)
+ expect(isCdcNumber(47809425348791 as unknown as string)).toBe(false)
+ expect(isCdcNumber(undefined as unknown as string)).toBe(false)
+ expect(isCdcNumber('AB123456789012345')).toBe(false)
+ expect(isCdcNumber('AB1234567890123')).toBe(false)
  })
 
  it('should return true if the input is correct', () => {
- expect(isCitizenDigitalCertificateNumber('AB12345678901234')).toBe(true)
- expect(isCitizenDigitalCertificateNumber('RP47809425348791')).toBe(true)
+ expect(isCdcNumber('AB12345678901234')).toBe(true)
+ expect(isCdcNumber('RP47809425348791')).toBe(true)
  })
 
  it('should return false if the input is incorrect', () => {
- expect(isCitizenDigitalCertificateNumber('ab12345678901234')).toBe(false)
- expect(isCitizenDigitalCertificateNumber('A112345678901234')).toBe(false)
- expect(isCitizenDigitalCertificateNumber('9B12345678901234')).toBe(false)
- expect(isCitizenDigitalCertificateNumber('AA123456789012J4')).toBe(false)
+ expect(isCdcNumber('ab12345678901234')).toBe(false)
+ expect(isCdcNumber('A112345678901234')).toBe(false)
+ expect(isCdcNumber('9B12345678901234')).toBe(false)
+ expect(isCdcNumber('AA123456789012J4')).toBe(false)
  })
 })

src/citizen-digital-certificate-number.ts

@@ -1,13 +1,13 @@
 /**
- * Verify the input is a valid citizen digital certificate number (自然人憑證)
+ * Verify the input is a valid Citizen Digital Certificate Number (自然人憑證)
  *
- * @param { string } input - citizen digital certificate number
- * @returns { boolean } is `input` a valid citizen digital certificate number
+ * @param { string } input - Citizen Digital Certificate Number
+ * @returns { boolean } is `input` a valid Citizen Digital Certificate Number
  * @example
- * isCitizenDigitalCertificateNumber('AB12345678901234') // true
- * isCitizenDigitalCertificateNumber('A12345678901234') // false
+ * isCdcNumber('AB12345678901234') // true
+ * isCdcNumber('A12345678901234') // false
  */
-export function isCitizenDigitalCertificateNumber(input: string): boolean {
+export function isCdcNumber(input: string): boolean {
  if (typeof input !== 'string') return false
 
  const n = input.toString()

src/index.ts

@@ -1,4 +1,4 @@
-export { isCitizenDigitalCertificateNumber } from './citizen-digital-certificate-number'
+export { isCdcNumber } from './citizen-digital-certificate-number'
 export { isEInvoiceCellPhoneBarcode } from './e-invoice-cell-phone-barcode'
 export { isEInvoiceDonateCode } from './e-invoice-donate-code'
 export { isBan } from './business-administration-number'