npm.io
2.2.11 • Published 3 years ago

slippi-combo-detector

Licence
AGPL-3.0-only
Version
2.2.11
Deps
10
Size
28.9 MB
Vulns
0
Weekly
0

Slippi Combo Detector

Author: Sasank 'squatch' Vishnubhatla

Pipeline Status: Pipeline Status

Coverage Report: Coverage Report

Latest Release: Latest Release

Introduction

To import the Slippi Combo Detector library, fist install it via npm:

npm install slippi-combo-detector --save-dev

Then, you will gain access to the ComboDetector and ConversionDetector classes and the following type:

  • Combo
    • ProcessedCombo
  • Conversion
    • ProcessedConversion
  • Move

In addition to these interfaces, the MoveName and MoveType enums are exposed as well.

Within the ComboDetector class, there are four public functions:

constructor(input: string): ComboDetector
getStats(): StatsType | null
getSettings(): SettingsType | null
getCombos(connectCode: string): Combo[]
getProcessedCombos(connectCode: string): ProcessedCombo[]

This parallels for the ConversionDetector class:

constructor(input: string): ConversionDetector
getStats(): StatsType | null
getSettings(): SettingsType | null
getConversions(connectCode: string): Conversion[]
getProcessedConversions(connectCode: string): ProcessedConversion[]

License

See LICENSE.