Feature TOP Build

使い方

K2HASH Node.jsをビルドした後で、動作確認をしてみます。

1. 実行環境の構築

まず、実行環境を構築します。
構築は、パッケージから構築する方法と、k2hash nodejs addonライブラリをビルドして利用する方法があります。

1.1 パッケージを利用して環境を構築

パッケージを利用して実行環境を構築する方法を説明します。
k2hash nodejs addonライブラリのパッケージは、npmにあります。

このパッケージをインストールする前に、k2hashの開発者パッケージが必要となりますので、k2hashのドキュメントを参照してください。
k2hashをインストールする方法も、パッケージからのインストールと、k2hashを自身でビルドする方法がありますので、使い方もしくはビルドのドキュメントを参照してください。

事前にk2hashライブラリをインストールした後、k2hash nodejs addonライブラリのnpmパッケージは、以下のようにインストールします。
npmコマンドの詳細についてはこちらを参照してください。

$ npm install k2hash

1.2 ビルドして環境を構築

ソースコードからk2hash nodejs addonライブラリをビルドすることができます。
ソースコードのgithubリポジトリをcloneし、ビルドする方法はこちらを参照してください。

2. サンプル

以下のようなファイルを作成し、ファイル作成、キーと値の書き込み、読み出しができるか確認してみてください。

var k2hash = require('k2hash');             // import k2hash nodejs addon library

var k2h    = k2hash();
k2h.create('test.k2h', 2, 4, 4, 128);       // create k2hash file for testing

k2h.setValue('testkey', 'testvalue');       // set test key with value
var value = k2h.getValue('testkey');        // get it

console.log(value);
k2h.close();                                // close k2hash file

3. ロード・実行

基本として、JavaScript言語でライブラリを読み込むためのrequireでK2HASH Node.js アドオンライブラリを読み込みます。
その後は、K2HASH Node.js アドオンライブラリが提供するクラス・関数・メソッドを呼び出してください。
具体的には、環境や言語（TypeScriptなど）に応じて利用してください。

4. その他のテスト

K2HASH Node.jsでは、MochaとChaiを使ったテストを実行できます。
以下のようにnpmコマンドを使い、作成したK2HASH Node.jsをテストすることができます。

$ npm run test
Feature TOP Build