Merge pull request #4327 from reppners/angular-localForage

+ typings for angular local forage

angular-localForage/angular-localForage-tests.ts

@@ -0,0 +1,126 @@
+/// <reference path='../angularjs/angular.d.ts' />
+/// <reference path='angular-localForage.d.ts' />
+
+var app = angular.module('angular-localForage-tests', ['LocalForageModule']);
+app.config(function (localStorageServiceProvider:angular.localForage.ILocalForageProvider) {
+
+    //TODO
+});
+
+var $rootScope:angular.IRootScopeService,
+    $localForage:angular.localForage.ILocalForageService,
+    instanceVersion = 0;
+
+// create a fresh instance
+$localForage.clear().then(function () {
+    $localForage = $localForage.createInstance({
+        name: ++instanceVersion
+    });
+});
+
+$localForage.getItem('this key is unknown').then(function (value) {
+
+});
+
+
+$localForage.setItem('myName', 'Olivier Combe').then(function (data) {
+
+    $localForage.getItem('myName').then(function (data) {
+    });
+});
+
+var values = ['Olivier Combe', 'AngularJs', 'Open Source'];
+
+$localForage.setItem(['myName', 'myPassion', 'myHobbie'], values).then(function (data) {
+
+    $localForage.getItem(['myHobbie', 'myName']).then(function (data) {
+    });
+
+});
+
+$localForage.removeItem('myName').then(function () {
+
+    $localForage.getItem('myName').then(function (data) {
+    });
+
+});
+
+$localForage.removeItem(['myName', 'myPassion']).then(function () {
+
+    $localForage.getItem(['myName', 'myPassion', 'myHobbie']).then(function (data) {
+    });
+
+});
+
+$localForage.pull('myName').then(function (data) {
+
+    $localForage.getItem('myName').then(function (data) {
+    });
+
+});
+$localForage.pull(['myName', 'myPassion']).then(function (data) {
+
+    $localForage.getItem(['myName', 'myPassion', 'myHobbie']).then(function (data) {
+    });
+
+});
+
+
+$localForage.setItem('myName', 'Olivier Combe').then(function (d) {
+
+    $localForage.getItem('myName').then(function (data) {
+    });
+
+});
+
+
+$localForage.setDriver('localStorageWrapper').then(function () {
+    $localForage.setItem('myName', 'Olivier Combe').then(function (d) {
+        $localForage.getItem('myName').then(function (data) {
+        });
+    });
+});
+
+$localForage.setItem('myArray', [{
+    $$hashKey: '00A',
+    name: 'Olivier Combe'
+}]).then(function (d) {
+
+    $localForage.getItem('myArray').then(function (data) {
+    });
+
+});
+
+$localForage.setDriver('localStorageWrapper').then(function () {
+    $localForage.setItem('myArray', [{
+        $$hashKey: '00A',
+        name: 'Olivier Combe'
+    }]).then(function (d) {
+
+        $localForage.getItem('myArray').then(function (data) {
+        });
+
+    });
+});
+
+var aFileParts = ["<a id=\"a\"><b id=\"b\">hey!<\/b><\/a>"];
+var oMyBlob = new Blob(aFileParts, {"type": "text\/xml"}); // the blob
+
+$localForage.setItem('myBlob', oMyBlob).then(function (data) {
+});
+
+// $localForage.setItem(['myName', 'myPassion', 'myHobbie'], 'value');
+
+// $localForage.setItem();
+
+
+$localForage.iterate(function (value, key) {
+}).then(function (data) {
+});
+
+$localForage.iterate(function (value, key) {
+    if (key == 'myPassion') {
+        return value;
+    }
+}).then(function (data) {
+});

angular-localForage/angular-localForage.d.ts

@@ -0,0 +1,63 @@
+// Type definitions for angular-localForage 1.2.2
+// Project: https://github.com/ocombe/angular-localForage
+// Definitions by: Stefan Steinhart <https://github.com/reppners>
+// Definitions: https://github.com/borisyankov/DefinitelyTyped
+
+/// <reference path="../localForage/localForage.d.ts" />
+/// <reference path="../angularjs/angular.d.ts" />
+
+declare module angular.localForage {
+
+    interface LocalForageConfig {
+        driver?:string;
+        name?:string | number;
+        version?:number;
+        storeName?:string;
+        description?:string;
+    }
+
+    interface ILocalForageProvider {
+        config(config:LocalForageConfig):void;
+        setNotify(onItemSet:boolean, onItemRemove:boolean):void;
+    }
+
+    interface ILocalForageService {
+        setDriver(driver:string):angular.IPromise<void>;
+        driver<T>():lf.ILocalForage<T>;
+
+        setItem(key:string, value:any):angular.IPromise<void>;
+        setItem(keys:Array<string>, values:Array<any>):angular.IPromise<void>;
+
+        getItem(key:string):angular.IPromise<any>;
+        getItem(keys:Array<string>):angular.IPromise<Array<any>>;
+
+        removeItem(key:string | Array<string>):angular.IPromise<void>;
+
+        pull(key:string):angular.IPromise<any>;
+        pull(keys:Array<string>):angular.IPromise<Array<any>>;
+
+        clear():angular.IPromise<void>;
+
+        key(n:number):angular.IPromise<string>;
+
+        keys():angular.IPromise<string>;
+
+        length():angular.IPromise<number>;
+
+        iterate<T>(iteratorCallback:(value:string | number, key:string)=>T):angular.IPromise<T>;
+
+        bind($scope:ng.IScope, key:string):void;
+
+        bind($scope:ng.IScope, config:{
+            key:string;
+            defaultValue:any;
+            scopeKey:string;
+            name:string;
+        }):void;
+
+        unbind($scope:ng.IScope, key:string, scopeKey?:string):void;
+
+        createInstance(config:LocalForageConfig):ILocalForageService;
+        instance(name:string):ILocalForageService;
+    }
+}