モジュール:Protect/doc

このモジュールは他のモジュールでエラー処理を簡略化するために使用されます。エラーを投げる可能性のある関数を変換して、エラーを投げる代わりにエラーメッセージを返すようにします。

使い方

local protect = require('モジュール:Protect')
local protectedFunc = protect(func, errFormat, options)

引数

• func

  変換される関数。

• errFormat (default: 'エラー: %s')

  返されるエラーメッセージの書式。

  funcが返すエラーメッセージは'%s'として指定します。

• options – 引数のテーブル。下記のキーが指定できます。
  • raw（既定値：false）

    trueの場合、errFormatの書式でエラーメッセージを返します。falseの場合、<strong class="error">で囲んで返します。

  • removeLocation（既定値：true）

    trueの場合、エラーメッセージから位置情報（エラーが起こったモジュールと行番号）を除去します。

戻り値

戻り値のprotectedFuncは関数であり、渡された引数をそのままfuncに渡し、その戻り値はそのままprotectedFuncの戻り値になります。funcがエラーを投げた場合、protectedFuncエラーを投げず、代わりにエラーメッセージを返します。

使用例

local protect = require('Module:Protect')

local p = {}

function p.main(frame)
    if not frame.args[1] then
        error('引数未入力')
    end
    return frame.args[1]
end

p.main = protect(p.main)

return p

main関数を引数なしで呼び出すと、と返されます。