vhad/DefinitelyTyped
1
0
Fork 0
mirror of https://github.com/gosticks/DefinitelyTyped.git synced 2025-10-16 12:05:41 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

[murmurhash] fix optional seed argument (#29788)

Browse Source 
* fix murmurhash optional argument

* improved readability of jsdocs
This commit is contained in:
Tom Raviv 2018-10-17 18:58:26 +03:00 committed by Sheetal Nandi
parent 83b0f8edf0
commit 6a357014b9
2 changed files with 19 additions and 8 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
types/murmurhash/index.d.ts vendored
View File

@ -9,21 +9,27 @@ export = murmurhash;
* JS Implementation of MurmurHash3 (r136) (as of May 20, 2011)
*
* @param key - ASCII only
* @param seed - Positive integer only
* @return - 32-bit positive integer hash
* @param seed - (optional) positive integer
* @returns 32-bit positive integer hash
*/
declare function murmurhash(key: string, seed: number): number;
declare function murmurhash(key: string, seed?: number): number;
declare namespace murmurhash {
// Circular reference from murmurhash
function v3(key: string, seed: number): number;
/**
* JS Implementation of MurmurHash3 (r136) (as of May 20, 2011)
*
* @param key - ASCII only
* @param seed - (optional) positive integer
* @returns 32-bit positive integer hash
*/
function v3(key: string, seed?: number): number;
/**
* JS Implementation of MurmurHash2
*
* @param str - ASCII only
* @param seed - Positive integer only
* @return - 32-bit positive integer hash
* @param seed - (optional) positive integer
* @returns 32-bit positive integer hash
*/
function v2(str: string, seed: number): number;
function v2(str: string, seed?: number): number;
}

5
types/murmurhash/murmurhash-tests.ts
View File

@ -3,6 +3,11 @@ import murmurhash = require('murmurhash');
const stringValue = "test";
let numberValue = 123;
numberValue = murmurhash(stringValue);
numberValue = murmurhash(stringValue, numberValue);
numberValue = murmurhash.v2(stringValue);
numberValue = murmurhash.v2(stringValue, numberValue);
numberValue = murmurhash.v3(stringValue);
numberValue = murmurhash.v3(stringValue, numberValue);