Ael.lang.String
説明
ネイティブ組み込みオブジェクトの一つであるStringオブジェクトを対象とした機能を提供します。
aelプロパティ
each
ael void each(function fn) : void
- @version 0.2
- @param {function} fn 関数
Aelオブジェクトが持つ文字列の文字毎に関数を呼び出す。 関数の引数にはプロパティ値、インデックス(0 始まり)、キー名を渡す。 関数から未定義値以外が返された場合、関数の呼び出しを止めて復帰する。
endsWith
ael endsWith(string suffix) : boolean
- @version 0.4
- @param {string} suffix 接尾辞
Aelオブジェクトが持つ文字列が引数の接尾辞で終わる場合はtrueを返す。
escapeHTML
ael escapeHTML() : string
- @version 0.4
- @return {string} エスケープ後文字列
Aelオブジェクトが持つ文字列が含むHTML特殊文字をエスケープする。
| 特殊文字 | 置換文字 |
| < | < |
| > | > |
| & | & |
| \ | " |
| ' | ' |
format
ael format() : string
- @version 0.2
- @param {string} ... 置換文字列
- @return {string} 置換後文字列
Aelオブジェクトが持つ文字列に含まれる特殊文字を引数の値に置き換えた文字列を返す。
indexOf
ael indexOf(string string[, number from]) : number
- @version 0.2
- @param {string} string 文字列
- @param {number} [from] 検索開始位置のインデックス
- @return {number} 指定した値が最初に出現したインデックス
Aelオブジェクトが持つ文字列の中に指定された文字列が最初に出現するインデックスを返す。
isEmpty
ael isEmpty(object value) : boolean
- @version 0.2
- @param {object} value 値
- @return {boolean} true - 値が空文字列の場合
Aelオブジェクトが持つ文字列の長さが 0 の場合は true を返す。
lastIndexOf
ael lastIndexOf(string string[, number from]) : number
- @version 0.4
- @param {string} string 文字列
- @param {number} [from] 検索開始位置のインデックス(末尾から)
- @return {number} 指定した値が最後に出現したインデックス
Aelオブジェクトが持つ文字列の中に指定された文字列が最後に出現するインデックスを返す。
replace
ael replace(string|RegExp regexp[, string|function replacement]) : string
- @version 0.4
- @param {string|RegExp} regexp 対象文字列、または対象文字列を表す正規表現
- @param {string|function} replacement 置換文字列、または置換文字列を返す関数
- @return {string} 置換後の文字列
Aelオブジェクトが持つ文字列に含まれる対象文字列を置換文字列へ置き換える。
第一引数は正規表現を指定することでマッチする対象を置換することができる。また第二引数に関数を指定することで対象文字列から置換文字列を動的に生成して置換することができる。
var count = 1;
var replaced = Ael("1_1_1_1_")
.replace(/_(1)/g, function(match, m1){
return parseInt(m1) + count++;
});
alert(replaced); //「1234_」と表示される
size
ael size() : number
- @version 0.4
- @return {number} 文字列長
Aelオブジェクトが持つ文字列の長さを返す。
startsWith
ael startsWith(string prefix) : boolean
- @version 0.4
- @param {string} prefix 接頭辞
Aelオブジェクトが持つ文字列の先頭が接尾辞と一致する場合はtrueを返す。
toJSONString
ael toJSONString([boolean partial]) : string
- @version 0.2
- @param {boolean} [partial] RFCに定められた最低限のエスケープを指示するフラグ(デフォルト:false)
- @return {string} JSON形式文字列
Aelオブジェクトが持つ文字列をJSON形式の文字列へ変換して返す。
詳細は「Ael#toJSONString()」を参照してください。
trim
ael trim([string chars]) : string
- @version 0.2
- @param {string} [chars] 削除する文字(default : " ")
- @return {string} trim後の文字列
Aelオブジェクトが持つ文字列の前後から指定した文字を取り除いた新しい文字列を返す。
取り去る文字が未指定の場合はデフォルト値(" ")を使用する。
unescapeHTML
ael unescapeHTML() : string
- @version 0.4
- @return {string} アンエスケープ後文字列
Aelオブジェクトが持つ文字列が含むエスケープされたHTML特殊文字を戻す。