diff --git a/enums/Gender.html b/enums/Gender.html index 9da196f..f52c065 100644 --- a/enums/Gender.html +++ b/enums/Gender.html @@ -1,6 +1,6 @@ Gender | norwegian-national-id-validator

Enumeration Gender

Birth numbers, D-number and H-number contains information about gender

-

Enumeration Members

Female +

Enumeration Members

Female Male

Enumeration Members

Female

Female: 1

If the third last digit in the ID number is even, it is a female

-

Male

Male: 0

If the third last digit in the ID number is odd, it is a male

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Male

Male: 0

If the third last digit in the ID number is odd, it is a male

+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/enums/IDNumberType.html b/enums/IDNumberType.html index 2ba336c..0818a86 100644 --- a/enums/IDNumberType.html +++ b/enums/IDNumberType.html @@ -1,18 +1,18 @@ IDNumberType | norwegian-national-id-validator

Enumeration IDNumberType

In Norway there are several different ID numbers

-

Enumeration Members

BirthNumber +

Enumeration Members

BirthNumber DNumber FHNumber HNumber

Enumeration Members

BirthNumber

BirthNumber: 0

A national identity number (birth number) is an ID number for you who have a residence permit and are going to live in Norway for more than six months.

-

DNumber

DNumber: 1

A D number is a temporary identification number that you get if you have +

DNumber

DNumber: 1

A D number is a temporary identification number that you get if you have applied for protection (asylum), or if you have a residence permit and are going to stay in Norway for less than six months.

-

FHNumber

FHNumber: 3

A FH number is used in health care to uniquely identify patients that +

FHNumber

FHNumber: 3

A FH number is used in health care to uniquely identify patients that does not have a known national ID or D number. A FH number does not have any information about age or gender.

-

HNumber

HNumber: 2

A H number is a number used for assistance, a unique identification of a +

HNumber

HNumber: 2

A H number is a number used for assistance, a unique identification of a person that does not have a national ID or a D number or in cases where this is not known. A H number contains information about age and gender.

-

Settings

Member Visibility

On This Page

Enumeration Members
+

Settings

Member Visibility

On This Page

Enumeration Members
diff --git a/functions/NorwegianId.html b/functions/NorwegianId.html index 76b5fb7..c3c5479 100644 --- a/functions/NorwegianId.html +++ b/functions/NorwegianId.html @@ -3,4 +3,4 @@

Settings

Member Visibility
+

Returns NorwegianIdObject

Settings

Member Visibility
diff --git a/functions/getGender.html b/functions/getGender.html index c7f39be..7a70128 100644 --- a/functions/getGender.html +++ b/functions/getGender.html @@ -1,4 +1,4 @@ getGender | norwegian-national-id-validator

Function getGender

  • getGender(elevenDigits: string): Gender | undefined

  • Returns the gender based of ID number. Returns undefined when no gender information is available.

    Parameters

    • elevenDigits: string

      ID number

      -

    Returns Gender | undefined

Settings

Member Visibility
+

Returns Gender | undefined

Settings

Member Visibility
diff --git a/functions/idNumberContainsBirthDate.html b/functions/idNumberContainsBirthDate.html index f2bc8be..350d9ff 100644 --- a/functions/idNumberContainsBirthDate.html +++ b/functions/idNumberContainsBirthDate.html @@ -1,3 +1,3 @@ idNumberContainsBirthDate | norwegian-national-id-validator

Function idNumberContainsBirthDate

  • idNumberContainsBirthDate(elevenDigits: string): boolean

  • Check if idNumber contains birth date

    Parameters

    • elevenDigits: string

      idNumber

      -

    Returns boolean

Settings

Member Visibility
+

Returns boolean

Settings

Member Visibility
diff --git a/functions/isValidDate.html b/functions/isValidDate.html index f32e298..5b56152 100644 --- a/functions/isValidDate.html +++ b/functions/isValidDate.html @@ -1,3 +1,3 @@ isValidDate | norwegian-national-id-validator

Function isValidDate

  • isValidDate(
        date: Date,
        expectedYear: string,
        expectedMonth: string,
        expectedDay: string,
    ): boolean

  • Checks if a date is valid against another

    Parameters

    • date: Date

      Date instance

      -
    • expectedYear: string
    • expectedMonth: string
    • expectedDay: string

    Returns boolean

Settings

Member Visibility
+
  • expectedYear: string
  • expectedMonth: string
  • expectedDay: string

    • Returns boolean

    Settings

    Member Visibility
    diff --git a/functions/possibleAgeOfPersonWithIdNumber.html b/functions/possibleAgeOfPersonWithIdNumber.html index 7a1cc10..ebfe01c 100644 --- a/functions/possibleAgeOfPersonWithIdNumber.html +++ b/functions/possibleAgeOfPersonWithIdNumber.html @@ -1,4 +1,4 @@ possibleAgeOfPersonWithIdNumber | norwegian-national-id-validator

    Function possibleAgeOfPersonWithIdNumber

    • possibleAgeOfPersonWithIdNumber(elevenDigits: string): number | undefined

    • Returns the age of a person with given Norwegian national identity number. Returns undefined when birth date could not be determined (e.g. for FH-numbers and invalid ID-numbers).

      Parameters

      • elevenDigits: string

        Identification number

        -

      Returns number | undefined

    Settings

    Member Visibility
    +

    Returns number | undefined

    Settings

    Member Visibility
    diff --git a/functions/possibleAgesOfPersonWithIdNumber.html b/functions/possibleAgesOfPersonWithIdNumber.html index a801914..04d6d10 100644 --- a/functions/possibleAgesOfPersonWithIdNumber.html +++ b/functions/possibleAgesOfPersonWithIdNumber.html @@ -1,3 +1,3 @@ possibleAgesOfPersonWithIdNumber | norwegian-national-id-validator

    Function possibleAgesOfPersonWithIdNumber

    • possibleAgesOfPersonWithIdNumber(elevenDigits: string): number[]

    • Find possible age of person based of ID number

      Parameters

      • elevenDigits: string

        Identification number

        -

      Returns number[]

    Settings

    Member Visibility
    +

    Returns number[]

    Settings

    Member Visibility
    diff --git a/functions/possibleBirthDateOfIdNumber.html b/functions/possibleBirthDateOfIdNumber.html index 0a27f7f..d5df8d3 100644 --- a/functions/possibleBirthDateOfIdNumber.html +++ b/functions/possibleBirthDateOfIdNumber.html @@ -1,3 +1,3 @@ possibleBirthDateOfIdNumber | norwegian-national-id-validator

    Function possibleBirthDateOfIdNumber

    • possibleBirthDateOfIdNumber(elevenDigits: string): Date | undefined

    • Get possible birth date from ID number

      Parameters

      • elevenDigits: string

        IdNumber

        -

      Returns Date | undefined

    Settings

    Member Visibility
    +

    Returns Date | undefined

    Settings

    Member Visibility
    diff --git a/functions/validateNorwegianIdNumber.html b/functions/validateNorwegianIdNumber.html index 745b1f7..370256f 100644 --- a/functions/validateNorwegianIdNumber.html +++ b/functions/validateNorwegianIdNumber.html @@ -4,4 +4,4 @@

    Example

    import { validateNorwegianIdNumber } from 'norwegian-national-id-validator';
    const valid = validateNorwegianIdNumber(0000000000);
    -

    Settings

    Member Visibility
    +

    Settings

    Member Visibility
    diff --git a/types/NorwegianIdObject.html b/types/NorwegianIdObject.html index 06f2cc7..c7876ca 100644 --- a/types/NorwegianIdObject.html +++ b/types/NorwegianIdObject.html @@ -11,4 +11,4 @@
  • isHNumber: () => boolean

    A H number is a number used for assistance, a unique identification of a person that does not have a national ID or a D number or in cases where this is not known. A H number contains information about age and gender.

    -
  • isMale: () => boolean
  • isValid: () => boolean

    • Settings

    Member Visibility
    +
  • isMale: () => boolean
  • isValid: () => boolean

    • Settings

    Member Visibility