TypeScript support, bug fixes, new documentation

[KillerJulian]

Hey👋,
this library is a bit outdated. Time for an update.

Improvements:

• TypeScript support
• Bug fixes
• New documentation
• Improves the code clarity
• Updated test script
• Automation of the repository

The rewrite took some time, so I would be happy about a small mention. Let me know if you disagree with my work.

With kind regards - Julian 🇩🇪

[KillerJulian]

Handling the new code

Editor 🖋️

1. I recommend the editor Visual Studio Code
2. I recommend to install the following addons:
   • EditorConfig for VS Code
   • ESLint
   • Prettier - Code formatter
   • Version Lens

Yarn 🛠️

I recommend using yarn as a package manager for a faster and cleaner working process.
Quick and easy installation.

Building the documentaion 📚

Use now yarn or alternatively npm.

1. Install the latest packages

yarn

2. Use the following command to generate the documentation

yarn build:docs

Later, Github will host the docs. But for the local view we need to install a small tool

yarn global add http-server

3. Last step, before you can view your work. Start the HTTP server

http-server docs

Automation of the repository ⚙️

Automation will make it faster and easier for your to work with the project. It also represents a change in your workflow. Decide for yourself whether you want to take this step.

Following will change it:

• When pushed to the master branch
  • The new documentation will be published on github.io
• When a pull request is opened or has been synchronized
  • The code will be linted
• When pushing to a branch
  • The code will be linted
• When a commit has been tagged with v*
  • A new release will be created
  • The new version is published on NPM

You always have the choice to customise the workflow to your needs.

Setup 🛠️

1. Set NPM token
   The token is needed to publish your package automatically

   1. Generate new token (Go to the npm website -> click on your profile picture -> Access Tokens -> Generate New Token)

      Name: node-pdu
      Type: Automation

      Copy your token.

   2. Set token at repository (Repository settings -> Secrets -> Action secrets -> New repository secret)

      Name: NPM_TOKEN
      Value: your token

2. Merge this pull request (read far below)

3. Github Pages
   After the first commit to master (also when you merge this pull request), the docs should be built. After that you can set the Github page.

   1. Go to the Pages setting in the repository (Repository settings -> Pages)

   2. Set up as follows:

      Source: Deploy from a branch
      Branch: gh-pages / (root)

4. Be happy when everything has worked

Merging this pull request 🔀

⚠️ Before merging these pull request, you should be aware of the changes. Please also read this comment thoroughly.

1. Setup the NPM-token
2. Merge via “Squash and merge”
3. Tag the merge commit with v2.0.0
4. Push the tag
5. Continue with the automation

---

For questions and suggestions I am at your disposal.
Thank you for your cooperation 🤝