gdドキュメント0.8.0

APIリファレンス

GD.text

文字列の整形と比較を行います。

メソッド

closest

closest(word: String, options: PackedStringArray) -> String

入力文字列に最も近い候補を選びます。コマンドやオプションの入力間違いに対する候補提示に使えます。

引数

名前型省略時の値説明
wordString省略不可英語原文 Input to compare against candidates.
optionsPackedStringArray省略不可英語原文 Candidate strings in selection order.

戻り値

String

編集距離が最小の最初の候補。距離がmax(2, word.length() / 3)を超える場合、または候補がない場合は空文字列。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

関連文書

ellipsis

ellipsis(text: String, width: int) -> String
英語原文

Shorten text to fit a width and append an ellipsis.

引数

名前型省略時の値説明
textString省略不可英語原文 Input string.
widthint省略不可英語原文 Maximum output length in characters.

戻り値

String

英語原文

The original text when it fits, otherwise a shortened form.

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

size_of

size_of(bytes: int) -> String
英語原文

Format a byte count with readable units.

引数

名前型省略時の値説明
bytesint省略不可英語原文 Byte count to format.

戻り値

String

英語原文

A human-readable size string.

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

duration

duration(ms: float) -> String
英語原文

Format milliseconds as a readable duration.

引数

名前型省略時の値説明
msfloat省略不可英語原文 Duration in milliseconds.

戻り値

String

英語原文

A human-readable duration string.

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

distance

distance(a: String, b: String) -> int

1つの文字列をもう1つの文字列にするために、文字の追加・削除・置換が何回必要かを求めます。これを編集距離と呼びます。値が小さいほどよく似ており、0なら一致しています。

引数

名前型省略時の値説明
aString省略不可1つ目の文字列。
bString省略不可2つ目の文字列。

戻り値

int

0以上の編集回数。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

関連文書

snake

snake(text: String) -> String
英語原文

Convert text to snake_case.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

camel

camel(text: String) -> String
英語原文

Convert text to camelCase.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

title

title(text: String) -> String
英語原文

Convert text to Title Case.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

table

table(rows: Array, gap: int = 2) -> String
英語原文

Format rows as an aligned text table.

引数

名前型省略時の値説明
rowsArray省略不可入力順の行。データベースの一括実行では各行が1組のパラメーターです。
gapint2整形した表の列間に入れる空白数。

戻り値

String

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

distance_async

distance_async(a: String, b: String) -> await int

1つの文字列をもう1つの文字列にするために、文字の追加・削除・置換が何回必要かを求めます。これを編集距離と呼びます。値が小さいほどよく似ており、0なら一致しています。

引数

名前型省略時の値説明
aString省略不可1つ目の文字列。
bString省略不可2つ目の文字列。

戻り値

await int

0以上の編集回数。

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

関連文書

closest_async

closest_async(word: String, options: PackedStringArray) -> await String

入力文字列に最も近い候補を選びます。コマンドやオプションの入力間違いに対する候補提示に使えます。

引数

名前型省略時の値説明
wordString省略不可英語原文 Input to compare against candidates.
optionsPackedStringArray省略不可英語原文 Candidate strings in selection order.

戻り値

await String

編集距離が最小の最初の候補。距離がmax(2, word.length() / 3)を超える場合、または候補がない場合は空文字列。

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

関連文書

ellipsis_async

ellipsis_async(text: String, width: int) -> await String
英語原文

Dispatch text shortening to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。
widthint省略不可整形する文字列の最大文字幅。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

snake_async

snake_async(text: String) -> await String
英語原文

Dispatch snake-case conversion to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

camel_async

camel_async(text: String) -> await String
英語原文

Dispatch camel-case conversion to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

title_async

title_async(text: String) -> await String
英語原文

Dispatch title-case conversion to a CPU worker.

引数

名前型省略時の値説明
textString省略不可調査・デコード・変換する文字列。入力自体は書き換えません。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。

table_async

table_async(rows: Array, gap: int = 2) -> await String
英語原文

Dispatch text-table formatting to a CPU worker.

引数

名前型省略時の値説明
rowsArray省略不可入力順の行。データベースの一括実行では各行が1組のパラメーターです。
gapint2整形した表の列間に入れる空白数。

戻り値

await String

完了を知らせるSignalを返します。awaitで完了を待つと、上に示した型の結果を受け取れます。

エラー

この関数は、結果とは別にErrを返す形式ではありません。結果の確認方法は、この関数の説明を参照してください。