APIリファレンス
GD.version
セマンティックバージョンを解析・比較し、指定したバージョン範囲に含まれるか調べます。
メソッド
parse(raw: String) -> Dictionary, Erris_canonical(raw: String) -> boolcompare(a: Dictionary, b: Dictionary) -> intis_stable(v: Dictionary) -> booltext(v: Dictionary) -> Stringbest(list: PackedStringArray, range: String = "*") -> Dictionary, Errbest_async(list: PackedStringArray, range: String = "*") -> await Dictionary, Errsatisfies(v: Dictionary, range: String) -> bool
parse
parse(raw: String) -> Dictionary, Err英語原文Parse version text into a component dictionary.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
raw | String | 省略不可 | 解析・検証するセマンティックバージョンの文字列。 |
戻り値
Dictionary, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
is_canonical
is_canonical(raw: String) -> bool英語原文Require a complete semantic version suitable for packages.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
raw | String | 省略不可 | 解析・検証するセマンティックバージョンの文字列。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
compare
compare(a: Dictionary, b: Dictionary) -> int英語原文Compare two versions.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
a | Dictionary | 省略不可 | 1つ目のセマンティックバージョン文字列。 |
b | Dictionary | 省略不可 | 2つ目のセマンティックバージョン文字列。 |
戻り値
int
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
is_stable
is_stable(v: Dictionary) -> bool英語原文Check whether a version is not a prerelease.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
v | Dictionary | 省略不可 | 整形・判定するバージョンの値。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
text
text(v: Dictionary) -> String英語原文Format a version dictionary as text.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
v | Dictionary | 省略不可 | 整形・判定するバージョンの値。 |
戻り値
String
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。
best
best(list: PackedStringArray, range: String = "*") -> Dictionary, Err英語原文Select the newest version within a range.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
list | PackedStringArray | 省略不可 | 一致する版を選ぶ候補バージョンの一覧。 |
range | String | "*" | 判定するバージョン制約。数値の区間ではありません。 |
戻り値
Dictionary, Err
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
best_async
best_async(list: PackedStringArray, range: String = "*") -> await Dictionary, Err英語原文Dispatch selection from large version lists to a CPU worker.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
list | PackedStringArray | 省略不可 | 一致する版を選ぶ候補バージョンの一覧。 |
range | String | "*" | 判定するバージョン制約。数値の区間ではありません。 |
戻り値
await Dictionary, Err
完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。
エラー
処理結果とエラー情報(Err)を返します。Errがnullなら成功です。失敗時にも途中までの結果が残る場合があるため、値を使う前にErrを確認してください。結果とErrを返す関数の中では、?でエラーをそのまま呼び出し元へ返せます。!はエラー時にプログラムを終了します。gd serveでは、そのリクエストの処理だけが終了します。
satisfies
satisfies(v: Dictionary, range: String) -> bool英語原文Check whether a version satisfies a range.
引数
| 名前 | 型 | 省略時の値 | 説明 |
|---|---|---|---|
v | Dictionary | 省略不可 | 整形・判定するバージョンの値。 |
range | String | 省略不可 | 判定するバージョン制約。数値の区間ではありません。 |
戻り値
bool
エラー
この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。