Gavia

GaviaはIndexedDBのためのActiveRecord風ライブラリです。検索結果をjQueryDeferred風のオリジナルDeferredオブジェクトで返すため、コールバックを多用することなく宣言的かつ簡潔に処理を書くことが出来ます。

依存関係もなく、GaviaのみでIndexedDBの処理を完結させることが出来ます。

Getting Started

bower install gavia

bowerはWeb開発用のJavaScriptパッケージマネージャです。

http://bower.io/

LICENSE

MIT LICENSE

Example

var db = new Gavia('test-db', {
  store: {
    keyPath: 'id',
    autoIncrement: true,
    index: {
      unique: true
    }
  }
});

var test = db.store.create();
test.hoge = 'hogehoge';
test.save().done(function() {
  console.log('save done');
});

db.store.filter(function(record) {
  return record.hoge.length > 5;
}).done(function(results) {
  results.forEach(function(result) {
    console.log(result);
  });
});

More Example

簡単なTODOアプリをGaviaを使って構築してみました。

http://kokudori.github.io/gavia/example/index.html

ソースはGistにて公開しています。

https://gist.github.com/kokudori/5559908

Gavia

DBを作成するにはGaviaコンストラクタを使います。

シグネチャ

gaviaDBObject = new Gavia('DBName', version, {  // optional version
	'ObjectStoreName': {
		keyPath: 'keyName',           // optional
		autoIncrement: Boolean,       // optional
		index: {                      // optional
			keyPath: 'indexKeyName',    // optional
			name: 'indexName',          // optional
			unique: Boolean,      // optional
			multiEntry: Boolean   // optional
		}
	},
	...
})

パラメータ

名前	概要	デフォルト値
DBName	作成するDBの名前。 IndexedDB内で一意の文字列を指定。	省略不可
version	DBのバージョンを指定。バージョンが上がるとオブジェクトストアの構成を変更する。	1
ObjectStoreName	作成するオブジェクトストアの名前。 DB内で一意の文字列を指定。	省略不可
keyPath	指定するオブジェクトストアの主キー。	省略するとオブジェクトの保存時にキーを指定する必要がある。
autoIncrement	オブジェクトを保存するたびにキー値を自動でインクリメントするかどうか。
index	オブジェクトストアのindexを指定。
index: keyPath	indexとなるプロパティの名前。	オブジェクトストアのkeyPath
index: name	作成するindexの名前。	indexのkeyPath。
index: unique	indexが一意かどうか。
index: multiEntry

作成したgaviaDBObjectへはGavia['DBName']でも同様にアクセス出来ます。また、gaviaDBObjectから個々のオブジェクトストアへも、オブジェクトストア名からプロパティアクセス可能です。

サンプル

var db = new Gavia('sample-db', {
	'sample-store': {
		keyPath: 'id'
	}
});
assert(db === Gavia['sample-db']);
db['sample-store']; // ストアオブジェクト

Gavia.Store.fn

オブジェクトストアへのメソッド群はGavia.Store.fnに定義されています。また、Gavia.Store.fnへ新たにユーザー定義メソッドを作ることも出来ます。

また、ほぼ全てのメソッドはDeferredを返します。

メソッド

名前	概要
all	全てのオブジェクトを取得。
bound	lower <= key <= upper となるオブジェクトを全て取得。
boundThan	lower < key < upper となるオブジェクトを全て取得。
clear	オブジェクトストアの全オブジェクトを削除。
create	新しくオブジェクトを作成。
delete	オブジェクトを削除
find	keyを元にオブジェクトを取得。
lower	key <= upper となるオブジェクトを全て取得。
lowerThan	key < upper となるオブジェクトを全て取得。
transaction	データの作成、削除を１つのトランザクション内で完結させる。
upper	lower <= key となるオブジェクトを全て取得。
upperThan	lower < key となるオブジェクトを全て取得。

サンプル

Gavia['sample-db']['sample-store']
	.find(10).done(function(result) {
		console.log(result);
	});

all

オブジェクトストアに属する全オブジェクトを取得。

シグネチャ

deferred = gaviaStoreObject.all({
	index: 'indexName',  // optional
	offset: Number,      // optional
	limit: Number,       // optional
	count: Boolean       // optional
});

パラメータ

名前	概要	デフォルト値
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.all().done(function(results) {
	console.log(results); // 1 ~ 9
});

gaviaStoreObject.all({
	offset: 2,
	limit: 4
}).done(function(results) {
	console.log(results); // 3 ~ 6
});

gaviaStoreObject.all({
	count: true
}).done(function(count) {
	console.log(count); // 9
});

bound

lower <= key <= upperとなるオブジェクトを全て取得。

boundThan

とは違い、境界を含む。

シグネチャ

deferred = gaviaStoreObject.bound(lower, upper, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
direction	オブジェクトを探索する方向を指定。詳しくは後述する。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

Gavia.Store.direction

Gavia.Store.directionはオブジェクトストアの探索方向を指定するものです。探索方向は昇順、重複なし昇順、降順、重複なし降順の４つがあります。

名前	概要
Gavia.Store.direction.next	昇順
Gavia.Store.direction.nextunique	重複なし昇順
Gavia.Store.direction.prev	降順
Gavia.Store.direction.prevunique	重複なし降順

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.bound(2, 8).done(function(results) {
	console.log(results); // 2 ~ 8
});

gaviaStoreObject.bound(2, 8, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 8 ~ 2
});

gaviaStoreObject.bound(2, 8, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 4 ~ 6
});

gaviaStoreObject.bound(2, 8, {
	count: true
}).done(function(count) {
	console.log(count); // 7
});

boundThan

lower < key < upperとなるオブジェクトを全て取得。

bound

とは違い、境界を含まない。

シグネチャ

deferred = gaviaStoreObject.boundThan(lower, upper, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
direction	オブジェクトを探索する方向を指定。詳しくはGavia.Store.directionを参照。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.boundThan(2, 8).done(function(results) {
	console.log(results); // 3 ~ 7
});

gaviaStoreObject.boundThan(2, 8, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 7 ~ 3
});

gaviaStoreObject.boundThan(2, 8, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 5 ~ 7
});

gaviaStoreObject.boundThan(2, 8, {
	count: true
}).done(function(count) {
	console.log(count); // 5
});

clear

オブジェクトストアに属するオブジェクトを全て削除する。

シグネチャ

deferred = gaviaStoreObject.clear();

サンプル

gaviaStoreObject.clear().done(function() {
	console.log('clear done');
});

create

オブジェクトを新しく作成。 saveするまでオブジェクトストアには保存されない。

シグネチャ

Object = gaviaStoreObject.create(key); // optional key

パラメータ

名前	概要	デフォルト値
key	keyPathを設定している場合は、作成時にkeyを設定する。	省略可能。

サンプル

var obj = gaviaStoreObject.create();
var obj2 = gaviaStoreObject.create(123);

delete

オブジェクトストアから特定のオブジェクトを削除。

シグネチャ

deferred = gaviaStoreObject.delete(key);

パラメータ

名前	概要	デフォルト値
key	削除したいオブジェクトのkey。	省略不可。

サンプル

gaviaStoreObject.delete(123).done(function() {
	console.log('delete done');
});

filter

オブジェクトストアから、値もしくは述語関数にマッチするオブジェクトを返す。

シグネチャ

deferred = gaviaStoreObject.filter(value, {
	index: 'indexName',      // optional
	offset: Number,          // optional
	limit: Number,           // optional
	count: Boolean           // optional
});
deferred = gaviaStoreObject.filter(prediacte, {
	index: 'indexName',      // optional
	offset: Number,          // optional
	limit: Number,           // optional
	count: Boolean           // optional
});

パラメータ

名前	概要	デフォルト値
value	keyと一致するオブジェクトを返す。	省略不可
predicate	述語関数。関数がtrueを返した時に渡されていたオブジェクト群を返す。	省略不可
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを
// idプロパティとして持つオブジェクトが存在すると仮定。
gaviaStoreObject.filter(function(result) {
	return result.id % 2 === 0;
}).done(function(odd) {
	console.log(odd); // id -> [2, 4, 6, 8]
});

gaviaStoreObject.filter(function(result) {
	return result.id % 2 === 0;
}, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // id -> [4, 6]
});

gaviaStoreObject.filter(function(result) {
	return result.id % 2 === 0;
}, {
	count: true
}).done(function(count) {
	console.log(count); // 4
});

gaviaStoreObject.filter(5).done(function(result) {
	console.log(result); // id -> 5
});

gaviaStoreObject.filter(5, {
	offset: 6
}).done(function(result) {
	console.log(result); // undefined
});

gaviaStoreObject.filter(5, {
	count: true
}).done(function(count) {
	console.log(count); // 1
});

find

オブジェクトストアからkeyを元にオブジェクトを取得。

シグネチャ

deferred = gaviaStoreObject.find(key, {
	index: 'indexName'       // optional
});

パラメータ

名前	概要	デフォルト値
key	探索対象のオブジェクトのkey。	省略不可
index	indexを指定

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.find(123).done(function(result) {
	console.log(result); // key が123のオブジェクト
});

gaviaStoreObject.find(123, {
	index: 'id'
}).done(function(result) {
	console.log(result); // key が123のオブジェクト
});

lower

key <= upper となるオブジェクトを全て取得。

lowerThan

とは違い、境界を含む。

シグネチャ

deferred = gaviaStoreObject.lower(upper, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
upper	upper以下となるkeyを持つオブジェクトを取得する。	省略不可。
direction	オブジェクトを探索する方向を指定。詳しくはGavia.Store.directionを参照。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.lower(6).done(function(results) {
	console.log(results); // 1 ~ 6
});

gaviaStoreObject.lower(6, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 6 ~ 1
});

gaviaStoreObject.lower(6, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 3 ~ 5
});

gaviaStoreObject.lower(6, {
	count: true
}).done(function(count) {
	console.log(count); // 6
});

lowerThan

key < upper となるオブジェクトを全て取得。

lower

とは違い、境界を含まない。

シグネチャ

deferred = gaviaStoreObject.lowerThan(upper, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
upper	upperより下となるkeyを持つオブジェクトを取得する。	省略不可。
direction	オブジェクトを探索する方向を指定。詳しくはGavia.Store.directionを参照。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.lowerThan(6).done(function(results) {
	console.log(results); // 1 ~ 5
});

gaviaStoreObject.lowerThan(6, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 5 ~ 1
});

gaviaStoreObject.lowerThan(6, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 3 ~ 5
});

gaviaStoreObject.lowerThan(6, {
	count: true
}).done(function(count) {
	console.log(count); // 5
});

transaction

対象のオブジェクトストアへの複数の操作を１つのトランザクション内で行う。

シグネチャ

deferred = gaviaStoreObject.transaction(store..., callback);

storeは複数指定可能。 callbackは引数の最後にしなければならない。

パラメータ

名前	概要	デフォルト値
store
callback	トランザクション内で行う処理。 callbackへは、transactionに渡したstore...と同じだけの数のtransactionStoreオブジェクトが引数として渡される。 falseを返すと、transaction全体がabortされる。

transactionStore

callbackに渡されるオブジェクト。 storeに対して変更を行うメソッドが２つ用意されている。

transactionStore.add(value) : オブジェクトストアにオブジェクトを追加する。
transactionStore.remove(key) : オブジェクトストアからオブジェクトを削除する。

サンプル

// store, other, anotherはいずれもGaviaのオブジェクトストアを意味する。
store.transaction(function(store) {
	store.add({
		id: 123
	});
	store.remove(234);
});

store.transaction(other, another, function(store, other, another) {
	store.add({
		id: 123
	});
	other.remove(234);
	another.add({
		id: 123
	});
});

store.tramsaction(other, function(other) {
	store.add({
		id: 123
	});
	other.remove(234);
	return false; // ここで書かれた処理全体が取り消される。
});

upper

lower <= key となるオブジェクトを全て取得。

upperThan

とは違い、境界を含む。

シグネチャ

deferred = gaviaStoreObject.upper(lower, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
lower	lower以上となるkeyを持つオブジェクトを取得する。	省略不可。
direction	オブジェクトを探索する方向を指定。詳しくはGavia.Store.directionを参照。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.upper(4).done(function(results) {
	console.log(results); // 4 ~ 9
});

gaviaStoreObject.upper(4, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 9 ~ 4
});

gaviaStoreObject.upper(4, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 6 ~ 8
});

gaviaStoreObject.upper(4, {
	count: true
}).done(function(count) {
	console.log(count); // 6
});

upperThan

lower < key となるオブジェクトを全て取得。

upper

とは違い、境界を含まない。

シグネチャ

deferred = gaviaStoreObject.upperThan(lower, {
	direction: Gavia.Store.direction,  // optional
	index: 'indexName',                // optional
	offset: Number,                    // optional
	limit: Number,                     // optional
	count: Boolean                     // optional
});

パラメータ

名前	概要	デフォルト値
lower	lowerより上となるkeyを持つオブジェクトを取得する。	省略不可。
direction	オブジェクトを探索する方向を指定。詳しくはGavia.Store.directionを参照。
index	indexを指定
offset	offset分、最初のオブジェクトを飛ばして取得。	0
limit	取得する最大数。
count	trueの場合、取得したオブジェクトの数を返す。	false

サンプル

// gaviaStoreObject に 1 ~ 9のkeyを持つオブジェクトが存在すると仮定。
gaviaStoreObject.upperThan(4).done(function(results) {
	console.log(results); // 5 ~ 9
});

gaviaStoreObject.upperThan(4, {
	direction: Gavia.Store.direction.prev
}).done(function(results) {
	console.log(results); // 9 ~ 5
});

gaviaStoreObject.upperThan(4, {
	offset: 2,
	limit: 2
}).done(function(results) {
	console.log(results); // 7 ~ 9
});

gaviaStoreObject.upperThan(4, {
	count: true
}).done(function(count) {
	console.log(count); // 5
});

Gavia.Record.fn

オブジェクトストアに保存されるオブジェクトへのメソッド群はGavia.Record.fnに定義されています。また、Gavia.Record.fnへ新たにユーザー定義メソッドを作ることも出来ます。

メソッド

名前	概要
delete	そのオブジェクトが属するオブジェクトストアから、対象のオブジェクトを削除する。
save	そのオブジェクトが属するオブジェクトストアへ、対象のオブジェクトを保存する。
update	オブジェクトのプロパテイ群を更新する。 saveメソッドを実行するまで、プロパティの更新はDBへ更新されない。

サンプル

Gavia['sample-db']['sample-store']
	.create(123)
	.update({
		name: 'Kokudori',
		age: 20
	}).save().done(function() {
		console.log('create, update and save done');
	});

delete

そのオブジェクトが属するオブジェクトストアから、対象のオブジェクトを削除する。

シグネチャ

deferred = gaviaRecordObject.delete(keyName); // optional keyName

パラメータ

名前	概要	デフォルト値
keyName	削除するオブジェクトのkeyとなるプロパティの名前。 keyPath、又はautoIncrementが指定されている場合は省略可能。

サンプル

gaviaRecordObject.delete().done(function() {
	console.log('delete done');
});

gaviaRecordObject.delete('id').done(function() {
	console.log('delete done');
});

save

そのオブジェクトが属するオブジェクトストアへ、対象のオブジェクトを保存する。

シグネチャ

deferred = gaviaRecordObject.save(key); // optional key

パラメータ

名前	概要	デフォルト値
key	保存するオブジェクトのkey。 keyPath、又はautoIncrementが指定されている場合は省略可能。

サンプル

gaviaRecordObject.save().done(function() {
	console.log('save done');
});

gaviaRecordObject.save(123).done(function() {
	console.log('save done');
});

update

オブジェクトのプロパテイ群を更新する。 saveメソッドを実行するまで、プロパティの更新はDBへ更新されない。

シグネチャ

gaviaRecordObject = gaviaRecordObject.update(properties);

パラメータ

名前	概要	デフォルト値
properties	更新するプロパテイ群。プロパティ名とプロパティ値を指定。

サンプル

gaviaRecordObject.update({
	hoge: 123,
	piyo: 234
});

Gavia.Deferred

jQueryDeferredライクな独自のDeferredオブジェクトです。非同期処理を合成することが出来ます。

メソッド

名前	概要
Deferred.when	複数のDeferredが全て成功するまで待つDeferredを返す。
done	Deferredが成功した時に呼ばれる関数を登録するメソッド。既に成功している場合は登録後すぐに呼ばれる。
fail	Deferredが失敗した時に呼ばれる関数を登録するメソッド。既に失敗している場合は登録後すぐに呼ばれる。
then	値もしくはDeferredを返す関数を渡す。値を返した場合は成功値を合成、 Deferredを返した場合はDeferredを合成する関数として振る舞う。
resolve\*	Deferredに成功値を渡す。既にDeferredが成功、もしくは失敗している場合は無視される。
reject\*	Deferredに失敗値を渡す。既にDeferredが成功、もしくは失敗している場合は無視される。
promise	Deferredからpromise, resolve, rejectメソッドを削除したものを返す。コールバックの登録のみを意図する場合に使用する。 GaviaのStore/Record APIは全てpromiseしたものを返している。

*: promiseメソッドの返り値には存在しないメソッド

サンプル

var deferred = new Gavia.Deferred().promise();
deferred.then(function(value) {
	return value + 1;
}).done(function(value) {
	assert(value, 2);
});
deferred.resolve(1);

Gavia.Deferred.when

複数のDeferredが全て成功するまで待つDeferredを返す。

シグネチャ

deferred = Gavia.Deferred.when(deferred1, deferred2, .. deferredN);

パラメータ

名前	概要	デフォルト値
deferredN	合成する各Deferredオブジェクト promiseされていてもされていなくてもどちらでも良い。

サンプル

Gavia.Deferred.when(deferred1, deferred2, deferred3)
	.done(function(result1, result2, result3) {
		console.log("全てのdeferredが成功");
		// 各resultパラメータには対応するdeferredの成功値が格納されている
	});

Gavia.Deferred.when(deferred1, deferred2, deferred3)
	.fail(function(result) {
		console.log("いずれかのdeferredが失敗");
		// resultパラメータは最初に失敗したdeferredの失敗値
	});

done

Deferredが成功した時に呼ばれる関数を登録するメソッド。既に成功している場合は登録後すぐに呼ばれる。

シグネチャ

deferred = deferred.done(callback);

パラメータ

名前	概要	デフォルト値
callback	deferredが成功した時に呼ばれる関数。 deferredの成功値がパラメータに渡される。

サンプル

deferred.done(function(result) {
		console.log("deferredが成功");
		// resultパラメータにはdeferredの成功値が格納されている
	});

fail

Deferredが失敗した時に呼ばれる関数を登録するメソッド。既に失敗している場合は登録後すぐに呼ばれる。

シグネチャ

deferred = deferred.fail(callback);

パラメータ

名前	概要	デフォルト値
callback	deferredが失敗した時に呼ばれる関数。 deferredの失敗値がパラメータに渡される。

サンプル

deferred.fail(function(result) {
		console.log("deferredが失敗");
		// resultパラメータにはdeferredの失敗値が格納されている
	});

then

値もしくはDeferredを返す関数を渡す。値を返した場合は成功値を合成、 Deferredを返した場合はDeferredを合成する関数として振る舞う。

シグネチャ

deferredN = deferred1.then(deferred2).then(value);

パラメータ

名前	概要	デフォルト値
deferred2	deferred1に合成するdeferredオブジェクト。 deferredNはdeferred1とdeferred2がどちらも成功すると成功に、どちらかもしくはどちらもが失敗すると失敗として扱われる。
value	deferred1の成功値に対する写像。

サンプル

deferred
	.then(value)
	.then(otherDeferred)
	.done(function(result) {
		// deferred, otherDeferredのいずれもが成功
	})
	.fail(function(result) {
		// deferred, otherDeferredのいずれかもしくはどちらかが失敗
	})

resolve

Deferredに成功値を渡す。既にDeferredが成功、もしくは失敗している場合は無視される。 (promiseメソッドの返り値には存在しないメソッド)

シグネチャ

deferred = deferred.resolve(value);

パラメータ

名前	概要	デフォルト値
value	deferredの成功値

サンプル

deferred
	.resolve(value)
	.done(function(result) {
		assert(result, value);
	});

reject

Deferredに失敗値を渡す。既にDeferredが成功、もしくは失敗している場合は無視される。 (promiseメソッドの返り値には存在しないメソッド)

シグネチャ

deferred = deferred.reject(value);

パラメータ

名前	概要	デフォルト値
value	deferredの失敗値

サンプル

deferred
	.reject(value)
	.fail(function(result) {
		assert(result, value);
	});

promise

Deferredからpromise, resolve, rejectメソッドを削除したものを返す。コールバックの登録のみを意図する場合に使用する。 GaviaのStore/Record APIは全てpromiseしたものを返している。

シグネチャ

promise = deferred.promise();

サンプル

deferred
	.resolve(value)
	.promise()
	.done(function(result) {
		assert(result, value);
	});

Thanks

Document is built using the pamflet.

pamflet is markdown to html generator by scala.

Contents

Gavia

Getting Started

LICENSE

Example

More Example

Gavia

シグネチャ

パラメータ

サンプル

Gavia.Store.fn

メソッド

サンプル

all

シグネチャ

パラメータ

サンプル

bound

シグネチャ

パラメータ

Gavia.Store.direction

サンプル

boundThan

シグネチャ

パラメータ

サンプル

clear

シグネチャ

サンプル

create

シグネチャ

パラメータ

サンプル

delete

シグネチャ

パラメータ

サンプル

filter

シグネチャ

パラメータ

サンプル

find

シグネチャ

パラメータ

サンプル

lower

シグネチャ

パラメータ

サンプル

lowerThan

シグネチャ

パラメータ

サンプル

transaction

シグネチャ

パラメータ

transactionStore

サンプル

upper

シグネチャ

パラメータ

サンプル

upperThan

シグネチャ

パラメータ

サンプル

Gavia.Record.fn

メソッド

サンプル

delete

シグネチャ

パラメータ

サンプル

save

シグネチャ

パラメータ

サンプル

update

シグネチャ

パラメータ