Class Parser

constructor

• new Parser(belfioreConnector): Parser

• Parameters

  • belfioreConnector: IBelfioreConnector

  Returns Parser

OMOCODE_BITMAP

cfDecode

• cfDecode(fiscalCode): Promise<default>

• Parameters

  • fiscalCode: string

    16 character Codice Fiscale to decode

  Returns Promise<default>

  Decoded CF Info

cfDeomocode

• cfDeomocode(codiceFiscale): string

• Convert omocode CF into plain one

  Parameters

  • codiceFiscale: string

    Partial or complete Omocode/Regular CF to parse, starting from LastName

  Returns string

  Regular CF w/o omocodes chars

cfOmocode

• cfOmocode(codiceFiscale, omocodeId): string

• Parameters

  • codiceFiscale: string
  • omocodeId: number

  Returns string

cfOmocodeId

• cfOmocodeId(codiceFiscale): number

• Parameters

  • codiceFiscale: string

  Returns number

cfToBirthDate

• cfToBirthDate(codiceFiscale): null | Date

• Parse birth date information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | Date

  Birth Date

cfToBirthDay

• cfToBirthDay(codiceFiscale): null | DateDay

• Parse birth day information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | DateDay

  Birth day (1..31)

cfToBirthMonth

• cfToBirthMonth(codiceFiscale): null | DateMonth

• Parse birth month information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | DateMonth

  Birth Month (0...11 - Date notation)

cfToBirthPlace

• cfToBirthPlace(codiceFiscale, checkBirthDateConsistency?): Promise<null | BelfiorePlace>

• Parse birth place information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse
  • checkBirthDateConsistency: boolean = true

    Ensure birthday is between creation and expiran date of the cf city or country, default value: true

  Returns Promise<null | BelfiorePlace>

  Birth place

cfToBirthYear

• cfToBirthYear(codiceFiscale): null | number

• Parse birth year information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | number

  Birth Year (4 digits)

cfToFirstName

• cfToFirstName(codiceFiscale): null | string

• Parse firstName information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | string

  Partial/possible firstName

cfToGender

• cfToGender(codiceFiscale): null | Genders

• Parse gender information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | Genders

  Male or female

cfToLastName

• cfToLastName(codiceFiscale): null | string

• Parse lastName information

  Parameters

  • codiceFiscale: string

    Partial or complete CF to parse

  Returns null | string

  Partial/possible lastName

dateGenderToCf

• dateGenderToCf(date, gender): null | string

• Parse Date and Gender information to create Date/Gender CF part

  Parameters

  • date: MultiFormatDate

    Date instance, ISO8601 date string or array of numbers [year, month, day]
  • gender: Genders

    Gender enum value

  Returns null | string

  Birth date and Gender CF code

dayGenderToCf

• dayGenderToCf(day, gender): null | string

• Parse day information

  Parameters

  • day: number

    Day number 1..31
  • gender: Genders

    Gender enum value

  Returns null | string

  Birth Day CF code

encodeCf

• encodeCf(__namedParameters): Promise<null | string>

• Generates full CF

  Parameters

  • __namedParameters: Omit<default, "place"> & {
        place?: string | BelfiorePlace;
    }

  Returns Promise<null | string>

  Complete CF

firstNameToCf

• firstNameToCf(firstName?): null | string

• Parse firstName to cf part

  Parameters

  • Optional firstName: null | string

    Partial or complete CF to parse

  Returns null | string

  partial cf

lastNameToCf

• lastNameToCf(lastName?): null | string

• Parse lastName to cf part

  Parameters

  • Optional lastName: null | string

    Partial or complete CF to parse

  Returns null | string

  partial cf

monthToCf

• monthToCf(month): null | string

• Parse month information

  Parameters

  • month: number

    Month number 0..11

  Returns null | string

  Birth Month CF code

parsePlace

• parsePlace(place): Promise<null | BelfiorePlace>

• Parse Place information to return city or country details

  Parameters

  • place: string | BelfiorePlace

    Belfiore place instance, belfiore code or city/country name

  Returns Promise<null | BelfiorePlace>

  BelfiorePlace instance with the target city or country details

placeToCf

• placeToCf(cityOrCountryName, provinceId?): Promise<null | string>

• Parse a Date and Gender information to create Date/Gender CF part

  Parameters

  • cityOrCountryName: string

    City or Country name
  • Optional provinceId: string

    Province code for cities

  Returns Promise<null | string>

  Matching place belfiore code, if only once is matching criteria
• placeToCf(birthDate, cityOrCountryName, provinceId?): Promise<null | string>

• Parameters

  • birthDate: MultiFormatDate
  • cityOrCountryName: string
  • Optional provinceId: string

  Returns Promise<null | string>

yearMonthDayToDate

• yearMonthDayToDate(year, month?, day?): null | Date

• Parse Year, Month, Day to Dated

  Parameters

  • year: undefined | null | number

    4 digits Year
  • month: undefined | null | DateMonth = 0

    1 or 2 digits Month 0..11
  • day: undefined | null | DateDay = 1

    1,2 digits Day 1..31

  Returns null | Date

  Date or null if provided year/month/day are not valid

yearToCf

• yearToCf(year): null | string

• Parse year to cf part

  Parameters

  • year: string | number

    Birth year 2 or 4 digit string, number above 19XX or below 100

  Returns null | string

  partial cf