mirror of
https://github.com/zhigang1992/DefinitelyTyped.git
synced 2026-04-23 21:00:01 +08:00
64 lines
1.7 KiB
TypeScript
64 lines
1.7 KiB
TypeScript
// Type definitions for jQueryTotalStorage 1.1.2
|
|
// Project: https://github.com/Upstatement/jquery-total-storage
|
|
// Definitions by: Jeremy Brooks <https://github.com/JeremyCBrooks/>
|
|
// Definitions: https://github.com/DefinitelyTyped/DefinitelyTyped
|
|
|
|
/// <reference types="jquery"/>
|
|
|
|
/**
|
|
* @desc Set the value of a key to a string
|
|
* @example $.totalStorage('the_key', 'the_value');
|
|
* @desc Set the value of a key to a number
|
|
* @example $.totalStorage('the_key', 800.2);
|
|
* @desc Set the value of a key to a complex Array
|
|
* @example var myArray = new Array();
|
|
* myArray.push({name:'Jared', company:'Upstatement', zip:63124});
|
|
* myArray.push({name:'McGruff', company:'Police', zip:60652};
|
|
* $.totalStorage('people', myArray);
|
|
* //to return:
|
|
* $.totalStorage('people');
|
|
*
|
|
*/
|
|
|
|
interface JQueryTotalStorage {
|
|
|
|
/**
|
|
* @desc Set or get a key's value
|
|
* @param key Key to set.
|
|
* @param value Value to set for key. If ommited, current value for key is returned.
|
|
* @param options Not implemented.
|
|
*/
|
|
(key: string, value?: any, options?: JQueryTotalStorageOptions): any;
|
|
|
|
/**
|
|
* @desc Set a key's value
|
|
* @param key Key to set.
|
|
* @param value Value to set for key.
|
|
*/
|
|
setItem(key: string, value: any): any;
|
|
|
|
/**
|
|
* @desc Get a key's value
|
|
* @param key Key to get.
|
|
*/
|
|
getItem(key: string): any;
|
|
|
|
/**
|
|
* @desc Get all set values
|
|
*/
|
|
getAll(): any[];
|
|
|
|
/**
|
|
* @desc Delete item by key
|
|
* @param key Key of item to delete
|
|
*/
|
|
deleteItem(key: string): boolean;
|
|
}
|
|
|
|
interface JQueryTotalStorageOptions {
|
|
//not implemented...
|
|
}
|
|
|
|
interface JQueryStatic {
|
|
totalStorage: JQueryTotalStorage;
|
|
} |