mizucoffee/sus-analyzer

View on GitHub
docs/meta.md

Summary

Maintainability
Test Coverage
## Functions

<dl>
<dt><a href="#getMeta">getMeta(sus)</a> ⇒ <code>ISusMeta</code></dt>
<dd><p>メタデータのオブジェクトを返す関数</p>
</dd>
<dt><a href="#validate">validate(sus)</a> ⇒ <code>ISusValidity</code></dt>
<dd><p>sus譜面が有効かどうかを返す関数</p>
</dd>
<dt><a href="#getValidMetaLines">getValidMetaLines(sus)</a> ⇒ <code>Array.&lt;Array.&lt;string&gt;&gt;</code></dt>
<dd><p>sus文字列から有効行を配列で返す関数</p>
</dd>
</dl>

<a name="getMeta"></a>

## getMeta(sus) ⇒ <code>ISusMeta</code>
メタデータのオブジェクトを返す関数

**Kind**: global function  
**Returns**: <code>ISusMeta</code> - メタデータ  

| Param | Type | Description |
| --- | --- | --- |
| sus | <code>String</code> | sus |

<a name="validate"></a>

## validate(sus) ⇒ <code>ISusValidity</code>
sus譜面が有効かどうかを返す関数

**Kind**: global function  
**Returns**: <code>ISusValidity</code> - 結果  

| Param | Type | Description |
| --- | --- | --- |
| sus | <code>String</code> | sus |

<a name="getValidMetaLines"></a>

## getValidMetaLines(sus) ⇒ <code>Array.&lt;Array.&lt;string&gt;&gt;</code>
sus文字列から有効行を配列で返す関数

**Kind**: global function  
**Returns**: <code>Array.&lt;Array.&lt;string&gt;&gt;</code> - sus有効行の配列  

| Param | Type | Description |
| --- | --- | --- |
| sus | <code>String</code> | sus |