https://github.com/personnummer/js-generate

Generate Swedish Personal Identity Numbers
https://github.com/personnummer/js-generate

generate hacktoberfest javascript personal-identity-number personnummer social-security-number

Last synced: 4 months ago
JSON representation

Generate Swedish Personal Identity Numbers

• Host: GitHub
• URL: https://github.com/personnummer/js-generate
• Owner: personnummer
• License: mit
• Created: 2020-05-01T14:41:51.000Z (about 5 years ago)
• Default Branch: master
• Last Pushed: 2024-10-02T21:43:29.000Z (8 months ago)
• Last Synced: 2024-10-09T00:18:40.819Z (8 months ago)
• Topics: generate, hacktoberfest, javascript, personal-identity-number, personnummer, social-security-number
• Language: TypeScript
• Size: 2.51 MB
• Stars: 6
• Watchers: 3
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: readme.md
  • License: license

Awesome Lists containing this project

README

        
# generate [![Build Status](https://img.shields.io/github/actions/workflow/status/personnummer/js/nodejs.yml?branch=master)](https://github.com/personnummer/js-generate/actions) [![NPM Downloads](https://img.shields.io/npm/dm/@personnummer/generate.svg)](https://www.npmjs.com/package/@personnummer/generate)

Generate Swedish Personal Identity Numbers.

## Installation

```

npm install @personnummer/generate

```

## Usage

```js

import generate from '@personnummer/generate';

const today = new Date();

// generate with date object

let pin = generate(today);

// generate with random date between now and the previous hundred years and the next hundred years

pin = generate();

// generate with specific gender

pin = generate({ gender: 'male' }); // or 'female'

// generate with date object and with specific gender

pin = generate(today, { gender: 'male' }); // or 'female'

```

## Options

```js

{

  gender: '',    // '' (random), 'male' or 'female',

  format: 'long' // 'long' or 'short'

}

```

This package follows the output format [specification](https://github.com/personnummer/meta#short-format).

## License

MIT