バイナリデータのバイト数(バッファのサイズ)

var buffer;
buffer = new Buffer(8);
print( buffer.length ); // 8

buffer = new Buffer("あいう", "uft8");
print( buffer.length ); // 9

Bufferオブジェクトを作成

var buffer;
buffer = new Buffer(8);
print( buffer.inspect() ); // バッファの内容を表示   不定

buffer = new Buffer([8,9,10]);
print( buffer.inspect() ); // <Buffer 08 09 0a>

buffer = new Buffer("あいう");  // buffer = new Buffer("あいう", "utf8");
print( buffer.inspect() ); // <Buffer e3 81 82 e3 81 84 e3 81 86>

buffer = new Buffer("CAkKCwwN", "base64");
print( buffer.inspect() ); // <Buffer 08 09 0a 0b 0c 0d>

buffer = new Buffer("08090a0b0c0d", "hex");
print( buffer.inspect() ); // <Buffer 08 09 0a 0b 0c 0d>

バッファ間でコピーする。

var buffer, bufferTarget;

buffer = new Buffer([1,2,3,4,5,6,7,8]);
bufferTarget = new Buffer(4);

buffer.copy(bufferTarget);
print( bufferTarget.inspect() ); // バッファの内容を表示  <Buffer 01 02 03 04>

buffer.copy(buffer, 3);
print( buffer.inspect() ); // <Buffer 01,02,03,01,02,03,04,05>

指定された値でバッファを埋める.

埋める値

埋める開始位置

埋める終了次位置

var buffer = new Buffer(8);
buffer.fill(0);
print( bufferTarget.inspect() ); // バッファの内容を表示  <Buffer 00 00 00 00 00 00 00 00>

buffer.fill(0xff, 4);
print( bufferTarget.inspect() ); // バッファの内容を表示  <Buffer 00 00 00 00 ff ff ff ff>

バッファから整数を取り出す.

trueならoffsetの是非をチェックしない. false(省略時)ならチェックします.

var buffer = new Buffer(6);

buffer.writeUInt32LE(0xffffffff);
buffer.writeUInt16LE(0x8000,4);

print(buffer.readInt32LE(0)); // -1
print(buffer.readInt16LE(4)); // -32768

バッファの内容を文字列化する.

var buf = new Buffer([0x41, 0x42, 0x43, 0x44, 0x45]);
print( buf.toString('utf8', 2) );	// "CDE"

文字列をバイト化して書き込む.

var buf = new Buffer([0x41, 0x42, 0x43, 0x44, 0x45]);
print( buf.toString() );	// "ABCDE"

var buf2 = new Buffer("あい");
buf.write(buf2, 2);
print( buf.toString() );  // "ABあ"

バッファへ整数を書き込む./div>

buffer.write{Type}( value, offset, [noAssert] ) : Integer

書き込む整数

バッファの先頭位置を指定する.

trueならoffsetの是非をチェックしない. false(省略時)ならチェックします.

inspect メソッド関数 Buffer...

buffer.inspect( [size] ) : String

バッファの内容の表示バイト数を指定します。省略時はBuffer.INSPECT_MAX_BYTES.

INSPECT_MAX_BYTES クラスプロパティ Buffer...

Buffer.INSPECT_MAX_BYTES : Integer (初期値 50)

byteLength クラス関数 Buffer...

Buffer.byteLength( string, [encoding] ) : Integer

print(Buffer.byteLength("あいう")); // 9
print("あいう".length); // 3

concat クラス関数 Buffer...

Buffer.concat( list, [totalLength] ) : Buffer

var buf1 = new Buffer([1,2,3]);
var buf2 = new Buffer([0x10,0x20]);
var buf = Buffer.concat( [buf1, buf2] );
print( buffer.inspect() ); // <Buffer 01 02 03 10 20>

isBuffer クラス関数 Buffer...

Buffer.isBuffer( object ) : Boolean

調べたいオブジェクト.

var array = [1,2,3];
var buffer = new Buffer(array);

print( Buffer.isBuffer(array) );  // false
print( Buffer.isBuffer(buffer));  // true

File System (fs)モジュール...

File Systemは、ファイル操作を扱うモジュールです。

このモジュールを使うには、最初にrequire関数でモジュールをロードします。

var fs = require('fs');
print( fs.rename("test.dat", "text.txt) );

rename, renameSync	ファイル名変更
truncate, truncateSync	ファイルのサイズを変更
unlink, unlinkSync	ファイルの削除
exists, existsSync	パスがあるかチェック
chmod, chmodSync	ファイルのモードを変更
readFile, readFileSync	ファイルからデータを読み出す
writeFile, writeFileSync	ファイルを作成し、データを書き込む
appendFile, appendFileSync	ファイルにデータを追記する
mkdir, mkdirSync	ディレクトリ作成
rmdir, rmdirSync	ディレクトリの削除
open, openSync	ファイルを開く
close, closeSync	ファイルを閉じる
write, writeSync	ファイルへデータを書く
read, readSync	ファイルからデータを読む

rename 関数File System...

fs.rename( source, dest )
fs.renameSync( source, dest )

に

var fs = require('fs');

try{
  fs.rename("d:\\work\\t.dat", "d:\\work\\t.txt");  // t.datファイル名を t.txtに変更
}catch(e){
  // ファイル名変更失敗
}

truncate 関数File System...

fs.truncate( path, size )
fs.truncateSync( path, size )

に

var fs = require('fs');

try{
  fs.rename("d:\\work\\t.dat", 128);  // t.datファイルのサイズを 128バイト変更
}catch(e){
  // ファイルのイズ変更失敗
}

unlink 関数File System...

fs.unlink( filename )
fs.unlinkSync( filename )

var fs = require('fs');

try{
  fs.unlink("d:\\work\\t.dat");
}catch(e){
  // ファイル削除を失敗
}

exists 関数File System...

fs.exists( path ) : Boolean
fs.existsSync( path ) : Boolean

var fs = require('fs');

print( fs.exists("d:\\work\\t.dat");  //あればtrue, なければfalse

chmod 関数File System...

fs.chmod( path, mode )
fs.chmodSync( path, mode )

var fs = require('fs');
fs.chmod("d:\\work\\t.dat", 0666);  //書き込みと読み取り(6 => 2|4)の権限をセットします

readFile 関数File System...

fs.readFile( filename, [encoding] ) : String or Buffer
fs.readFileSync( filename, [encoding] ) : String or Buffer

var fs = require('fs');

var txt = fs.readFile("d:\\work\\t.dat", 'utf8');

writeFile 関数File System...

fs.writeFile( filename, data, [encoding] )
fs.writeFileSync( filename, data, [encoding] )

var fs = require('fs');

var buf = new Buffer([1,2,3,4,5]);
try{
  fs.writeFile("d:\\work\\t.dat", "あいうえお', 'utf8');
  fs.writeFile("d:\\work\\bin.dat", buf);
}catch(e){
  //書き込み失敗
}

appendFile 関数File System...

fs.appendFile( filename, data, [encoding] )
fs.appendFileSync( filename, data, [encoding] )

var fs = require('fs');

var buf = new Buffer([1,2,3,4,5]);
var buf2 = new Buffer([6,7,8,9,10]);
try{
  fs.writeFile("d:\\work\\t.dat", "abcd", 'utf8');
  fs.appendFile("d:\\work\\t.dat", "あいうえお', 'utf8');

  fs.writeFile("d:\\work\\bin.dat", buf);
  fs.appendFile("d:\\work\\bin.dat", buf2);
}catch(e){
  //追記 失敗
}

mkdir 関数File System...

fs.mkdir( dirname )
fs.mkdirSync( dirname )

var fs = require('fs');

try{
  fs.mkdir("d:\\work\\A");
}catch(e){
  //削除失敗
}

rmdir 関数File System...

fs.rmdir( dirname )
fs.rmdirSync( dirname )

var fs = require('fs');

try{
  fs.rmdir("d:\\work");
}catch(e){
  //削除失敗
}

open 関数File System...

fs.open( path, flags, [mode] ) : Integer
fs.openSync( path, flags, [mode] ) : Integer

var fs = require('fs');

var fd = -1;
var buffer, len;
try{
  // write
  fd = fs.open("mytext.data", "w", 0666);
  fs.write(fd, "I like OgO.");
  fs.close(fd);

  // read
  fd = fs.open("mytext.data", "r");
  buffer = new Buffer(128);
  len = fs.read(fd, buffer);
  print(buffer.toString()); // I like OgO.
  fs.close(fd);
}catch(e){
  //失敗
}

close 関数File System...

fs.close( fd )
fs.closeSync( fd )

write 関数File System...

fs.write( fd, buffer[, offset[, length[, position]]] ) : Integer
fs.write( fd, data[, position[, encoding]] ) : Integer
fs.writeSync( fd, buffer[, offset[, length[, position]]] ) : Integer
fs.writeSync( fd, data[, position[, encoding]] ) : Integer

var fs = require('fs');

var fd = -1;
var buffer;
try{
  fd = fs.open("mydata.dat", "w", 0666);
  buffer = new Buffer("あいう");
  
  fs.write(fd, buffer);
  fs.close(fd);
}catch(e){
  //失敗
}

read 関数File System...

fs.read( fd, buffer[, offset[, length[, position]]] ) : Integer
fs.readSync( fd, buffer[, offset[, length[, position]]] ) : Integer

var fs = require('fs');

var fd = -1;
var buffer;
try{
  fd = fs.open("mydata.dat", "r");
  buffer = new Buffer(128);
  
  fs.read(fd, buffer, 0, buffer.length);
  print( buffer.toString() );

  fs.close(fd);
}catch(e){
  //失敗
}

Module...

CommonJSではモジュール機能を exports, moduleオブジェクトとrequire関数を使ってを実現します。

モジュールとして読み込まれる側のコードと、モジュールを読む側のコードをそれぞれ以下のように書きます。

■ モジュールとして読み込まれる側のコード smath.js

// smath.js
function add(x,y) {
  return x + y;
}
function mul(x,y) {
  return x * y;
}

exports.add = add;  //add関数を他のモジュールから使えるようにexportします。
exports.mul = mul;  //mull関数を ・・・

■ モジュールを読む側のコード sample.js

var smath = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード

alert( smath.add(10, 20) );   // 30
alert( smath.mul(10, 20) );   // 200

//=別バージョン=
var {add, mul} = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード

alert( add(10, 20) );   // 30
alert( mul(10, 20) );   // 200

JavaScriptでは、複数のコードに同名のグローバル変数が定義されることを「変数の衝突」と呼んでいます。この「変数の衝突」がバグを起こす原因を多く作っています。
そこで exports変数,require関数を使ってモジュール化すれば、モジュールとして読み込まれる側のコードにある変数はすべてローカル変数となり「変数の衝突」を防げます。

そして モジュールの情報はmoduleオブジェクトにセットされています。

exports	exportしたい変数や関数をプロパティにセットする
module	モジュール情報
module.exports	exportしたい変数や関数をプロパティにセットする
module.filename	モジュールのフルパス名
module.id	モジュールの識別子
require関数	ファイルモジュールをロード
require.main関数	メインモジュール
__dirname	現在実行されているスクリプトのディレクトリ
__filename	現在実行されているスクリプトのフルパス名

exports Module...

exports : Object

exportsはモジュールとして読み込まれる側のコードにおいて、外部に公開したい関数やデータをexportsオブジェクトのプロパティにセットします。
各モジュールのexportsは異なるオブジェクトであり、このモジュールを読む側のコードのrequire関数の返値はこのexportsオブジェクトです。

exportsはmodule.exportsオブジェクトがセットされたモジュール内のローカル変数です。

例
  ■ モジュールとして読み込まれる側のコード smath.js
    // smath.js
    function add(x,y) {
      return x + y;
    }
    function mul(x,y) {
      return x * y;
    }
    
    exports.add = add;  //add関数を他のモジュールから使えるようにexportします。
    exports.mul = mul;  //mull関数を ・・・
  
  ■ モジュールを読む側のコード sample.js
    var smath = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード
    
    alert( smath.add(10, 20) );   // 30
    alert( smath.mul(10, 20) );   // 200
    
    //=別バージョン=
    var {add, mul} = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード
    
    alert( add(10, 20) );   // 30
    alert( mul(10, 20) );   // 200

moduleModule...

module : Object

moduleは実行中のモジュールの情報を含んだオブジェクトです。
各モジュールのmoduleは異なるオブジェクトであり、外部公開しない限り他のモジュールから参照できません。ただし、メイン(Scriptスタートモジュールの)moduleオブジェクトはrequire.mainで参照できます。

例
  モジュールがメイン(Scriptスタート)モジュールかどうかの判定

    if (module==require.main) {
      // このモジュールはメインモジュールである
      // ・・・
    }

module.exports Module...

module.exports : Object

module.exportsはモジュールとして読み込まれる側のコードにおいて、外部に公開したい関数やデータをmodule.exportsオブジェクトのプロパティにセットします。
各モジュールのmodule.exportsは異なるオブジェクトであり、このモジュールを読む側のコードのrequire関数の返値はこのmodule.exportsオブジェクトです。

モジュール内のローカル変数 exportsは モジュール実行直前にmodule.exportsオブジェクトがセットされ、exportのコードを簡略にしています。

例
  ■ モジュールとして読み込まれる側のコード smath.js
    // smath.js  exportsオブジェクトを関数に変更する例
    exports = module.exports = function() { alert("I am a smath-module."); }
    
    function add(x,y) {
      return x + y;
    }
    function mul(x,y) {
      return x * y;
    }
    
    module.exports.add = add;  //add関数を他のモジュールから使えるようにexportします。
    module.exports.mul = mul;  //mull関数を ・・・
  
  ■ モジュールを読む側のコード sample.js
    var smath = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード
    
    alert( smath.add(10, 20) );   // 30
    alert( smath.mul(10, 20) );   // 200
    
    smath();  // I am a smath-module.

module.filenameModule...

module.filename : String

module.filenameは実行中のモジュールのフルパス名です。

例
  ■ モジュールとして読み込まれる側でフルパス名を表示
    // smath.js
    function add(x,y) {
      return x + y;
    }
    function mul(x,y) {
      return x * y;
    }
    
    exports.add = add;  //add関数を他のモジュールから使えるようにexportします。
    exports.mul = mul;  //mull関数を ・・・

    alert(module.filename);  // d:\work\smath.js

module.idModule...

module.id : String

module.idは実行中のモジュールの識別子です。
現在の仕様では
  file://モジュールのフルパス名
となっています。(将来変更される可能性あり)

例
  ■ モジュールとして読み込まれる側で識別子を表示
    // smath.js
    function add(x,y) {
      return x + y;
    }
    function mul(x,y) {
      return x * y;
    }
    
    exports.add = add;  //add関数を他のモジュールから使えるようにexportします。
    exports.mul = mul;  //mull関数を ・・・

    alert(module.id);  // file://d:\work\smath.js

require 関数 Module...

require( modulename ) : Object

require関数を使ったモジュールロードは、「名前空間の衝突」を避けます。 さらに、ロードは最初の1回のみで次回からのrequire関数呼出はモジュールのロードされずシステムキャッシュに保存された exportsオブジェクトを返します。

例
  ■ モジュールを読む側のコード
    var smath = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード
    
    alert( smath.add(10, 20) );   // 30
    alert( smath.mul(10, 20) );   // 200
    
    //=別バージョン=
    var {add, mul} = require('./smath');	// このコードと同じフォルダーにあるモジュールをロード
    
    alert( add(10, 20) );   // 30
    alert( mul(10, 20) );   // 200

    //OgOの指定パス順序でモジュールをサーチ
    var {WScript} = require("wsh");
    var excel = WScript.CreateObject("Excel.Application");
    excel.Visible = true;

require.mainModule...

require.main : Object

require.mainはメイン(Scriptスタートモジュールの)moduleです。
requireは各モジュールの関数であることから、各モジュールはメインモジュールを知ることができます。

例
  モジュールがメイン(Scriptスタート)モジュール)かどうかの判定

    if (module==require.main) {
      // このモジュールはスタートモジュールである
      // ・・・
    }

__dirnameModule...

__dirname : String

__filenameModule...

__filename : String

module.filenameと同じ内容です。

Path モジュール...

Pathは、ファイルパスを扱うモジュールです。

このモジュールを使うには、最初にrequire関数でモジュールをロードします。

var Path = require('path');
print( Path.basename("d:\\work\\test.dat") ); // test.dat

定数
sep	ファイルセパレータ
delimiter	環境変数Path内の区切り
関数
normalize	パス名を正規化
join	文字列を結合してパス名を作成
resolve	絶対パスを作成する
isAbsolute	絶対パスかどうかを判定
dirname	ディレクトリ名を取得
basename	ファイル名を取得
extname	拡張子を取得
parse	ファイルパスの各部分を取得

sep 定数JS1.0Path...

Path.sep : String

var Path = require('path');

'foo\\bar\\baz'.split(Path.sep);  // ['foo', 'bar', 'baz']

delimiter 定数JS1.0Path...

Path.delimiter : String

normalize 関数JS1.0Path...

Path.normalize( pathname ) : String

var Path = require('path');

print( Path.normalize("d:\\work\\..\\t.dat") ); // d:\t.dat
print( Path.normalize("d:/work/../t.dat") ); // d:\t.dat
print( Path.normalize("..\\..\\t.dat") );    // ..\..\t.dat

join 関数Path...

Path.join( [path1],[path2], [...] ) : String

var Path = require('path');

print( Path.join("work", "t.dat") ); // work\t.dat
print( Path.join("d:\\work", "..", "t.dat") ); // d:\t.dat

resolve 関数Path...

Path.resolve( [from ...], to ) : String

var Path = require('path');

print( Path.resolve("d:\\work", "test", "temp", "..", "t.dat") ); // d:\work\test\t.dat
print( Path.resolve("work", "test", "..", "t.dat") ); // d:\work\t.dat

isAbsolute 関数Path...

Path.isAbsolute( path ) : Boolean

var Path = require('path');

print( Path.isAbsolute("d:\\work\\test.dat") ); // true
print( Path.isAbsolute("work\\test.dat") ); // false

dirname 関数Path...

Path.dirname( path ) : String

var Path = require('path');

print( Path.dirname("d:\\work\\test.dat") ); // d:\work
print( Path.dirname("work\\..\\test.dat") ); // work\..\test.dat

basename 関数Path...

Path.basename( path ) : String

var Path = require('path');

print( Path.basename("d:\\work\\test.dat") ); // test.dat
print( Path.basename("work\\..\\test.dat") ); // test.dat

extname 関数Path...

Path.extname( path ) : String

var Path = require('path');

print( Path.extname("d:\\work\\test.dat") ); // .dat
print( Path.extname("work\\..\\test") ); // 空文字列

parse 関数Path...

Path.parse( path ) : Object

  var Path = require('path');
  var ans = Path.parse("d:\\work\\test.dat"); 
  print( ans.dir ); // d:\work
  print( ans.root ); // d:\
  print( ans.base ); // test.dat
  print( ans.name ); // test
  print( ans.ext ); // .dat