Class: Log

at.pkgs. Log

ログクラス. チュートリアル: at.pkgs.Log

new Log(name, instance)

Parameters:
Name Type Argument Description
name String

ログ名称.

instance at.pkgs.Log <optional>

インスタンス.

Since:
  • 0.1.0
Source:

Extends

Members

<static, constant> DEBUG :Number

デバッグログレベル.

Type:
  • Number
Since:
  • 0.1.0
Source:

<static, constant> ERROR :Number

エラーログレベル.

Type:
  • Number
Since:
  • 0.1.0
Source:

<static, constant> INFO :Number

情報ログレベル.

Type:
  • Number
Since:
  • 0.1.0
Source:

<static> instances :Object

ログ名称をキーとするログインスタンスのマップ.

Type:
  • Object
Since:
  • 0.1.0
Source:

<static, constant> LEVELS :String[]

ログレベル名称の配列.

Type:
  • String[]
Since:
  • 0.1.0
Source:

level :Number

出力対象となる最詳のログレベル.

Type:
  • Number
Since:
  • 0.1.0
Source:

name :String

ログ名称.

Type:
  • String
Since:
  • 0.1.0
Source:

<readonly> parent :Object

親クラスのプロトタイプへの参照.

Type:
  • Object
Since:
  • 0.1.3
Inherited From:
Source:

<readonly> self :Function

コンストラクタへの参照.

Type:
  • Function
Since:
  • 0.1.0
Inherited From:
Source:

Methods

<static> append(message, trace) → {Boolean}

ログを書込む.

メッセージを指定しない場合はログを出力せずに、ログの有効確認のみを行う. このメソッドを上書きすることでログの出力先を変更可能. 標準ではconsole.logへ書き込みを行う.

Parameters:
Name Type Argument Description
message String <optional>

ローマット済のメッセージ.

trace String <optional>
<nullable>

コールスタック.

Since:
  • 0.1.0
Source:
Returns:

ログ出力が有効であればtrue.

Type
Boolean

<static> debug(name) → {at.pkgs.Log}

ログ名称を指定してデバッグログを有効にする.

Parameters:
Name Type Description
name String

ログ名称.

Since:
  • 0.1.0
Source:
Returns:

ログ.

Type
at.pkgs.Log

<static> format(template, parameter)

メッセージをフォーマットする.

このメソッドを上書きすることでフォーマッタを変更可能.

Parameters:
Name Type Argument Description
template String

ログ出力メソッドの第1引数.

parameter * <repeatable>

ログ出力メソッドの第2引数以降.

Since:
  • 0.1.0
Source:
Returns:

フォーマット済みの文字列.

<static> get(name) → {at.pkgs.Log}

ログ名称を指定してログを取得する.

Parameters:
Name Type Description
name String

ログ名称.

Since:
  • 0.1.0
Source:
Returns:

ログ.

Type
at.pkgs.Log

_catch_(error) → {at.pkgs.Log}

例外ログを出力し、例外を無視する.

Parameters:
Name Type Description
error Error

例外.

Since:
  • 0.1.0
Source:
Returns:

ログ.

Type
at.pkgs.Log

_throw_(error)

例外ログを出力し、例外を再throwする.

Parameters:
Name Type Description
error Error

例外.

Since:
  • 0.1.0
Source:
Throws:
パラメタの例外を再throwする.
Type
Error

debug(template, parameter) → {Boolean}

デバッグログを出力する.

メッセージを指定しない場合はログを出力せずに、ログの有効確認のみを行う.

Parameters:
Name Type Argument Description
template String <optional>

メッセージテンプレート.

parameter * <repeatable>

テンプレートパラメタ.

Since:
  • 0.1.0
Source:
Returns:

ログ出力が有効であればtrue.

Type
Boolean

error(template, parameter) → {Boolean}

エラーログを出力する.

メッセージを指定しない場合はログを出力せずに、ログの有効確認のみを行う.

Parameters:
Name Type Argument Description
template String <optional>

メッセージテンプレート.

parameter * <repeatable>

テンプレートパラメタ.

Since:
  • 0.1.0
Source:
Returns:

ログ出力が有効であればtrue.

Type
Boolean

immediate() → {Boolean}

指定された名称のプロパティを直接持つか取得する.

Parameters:
Name Type Description
プロパティ名. String
Since:
  • 0.1.5
Inherited From:
Source:
Returns:

持つならばtrue.

Type
Boolean

info(template, parameter) → {Boolean}

情報ログを出力する.

メッセージを指定しない場合はログを出力せずに、ログの有効確認のみを行う.

Parameters:
Name Type Argument Description
template String <optional>

メッセージテンプレート.

parameter * <repeatable>

テンプレートパラメタ.

Since:
  • 0.1.0
Source:
Returns:

ログ出力が有効であればtrue.

Type
Boolean

log(level, parameters, trace) → {Boolean}

ログを出力する.

メッセージフォーマットパラメタを指定しない場合はログを出力せずに、ログの有効確認のみを行う.

Parameters:
Name Type Argument Description
level

ログレベル.

parameters Function.Arguments <optional>

メッセージフォーマットパラメタ.

trace String <optional>

コールスタック.

Since:
  • 0.1.0
Source:
Returns:

ログ出力が有効であればtrue.

Type
Boolean

stack(error) → {String|Boolean}

例外からコールスタックを取得する.

Parameters:
Name Type Description
error Error

例外.

Since:
  • 0.1.0
Source:
Returns:

コールスタックまたはfalse.

Type
String | Boolean

trap(callback, suppress, inject) → {Function}

関数をラップし、例外ログの捕捉を有効にする.

Parameters:
Name Type Argument Description
callback Function

ラップ対象の関数.

suppress Boolean <optional>

例外の再throwを行わない場合はtrueを指定.

inject Boolean <optional>

ログインスタンスの注入を行う場合はtrueを指定.

Since:
  • 0.1.0
Source:
Returns:

ラップ匿名関数.

Type
Function
Copyright (c) 2009-2014, Architector Inc., Japan.
Documentation generated by JSDoc 3.2.0 on Tue Aug 26 2014 22:27:18 GMT+0900 (JST) using the DocStrap template.