WCA Helpers

Helpers and class definitions for WCA and WCIF

This package contains TypeScript interfaces for the different classes used in WCIF, as well as a library of helper functions to help you deal with WCA data, such as calculating averages and en/de-coding multi blind results.

Installation

npm install @wca/helpers --save

Usage example

Development setup

Release process

Releases are managed by Release Please.

Use Conventional Commit prefixes when merging changes to master:

• fix: creates a patch release.
• feat: creates a minor release.
• feat!:, fix!:, or a BREAKING CHANGE: footer creates a major release.

Release Please keeps a release PR up to date with the next version, changelog, and package version files. Merge that release PR when the release should be published.

Do not manually bump the package version for normal releases.

Contributing

1. Fork it (https://github.com/thewca/wca-helpers/fork)
2. Create your feature branch (git checkout -b feature/fooBar)
3. Commit your changes (git commit -am 'Add some fooBar')
4. Push to the branch (git push origin feature/fooBar)
5. Create a new Pull Request

Meta

Distributed under the GPL license. See LICENSE for more information.

https://github.com/thewca/wca-helpers