Interface IMurHasherConstructor

A factory interface for murmurhash incremental utility

Hierarchy

IMurHasherConstructor

Index

Constructors

constructor

Properties

SERIAL_BYTE_LENGTH

Constructors

constructor

new IMurHasherConstructor(): IMurHasher
new IMurHasherConstructor(seed: number, endianness?: Endianness): IMurHasher
new IMurHasherConstructor(serial: string | Buffer, endianness?: Endianness): IMurHasher
new IMurHasherConstructor(hash: IMurHasher, endianness?: Endianness): IMurHasher

- Defined in incremental.d.ts:142
Creates MurmurHash utility.

The default seed is 0 and the endianness is set to "BE".

Returns IMurHasher
- Defined in incremental.d.ts:148
Creates MurmurHash utility.

If not provided, the endianness is set to "BE".

Parameters
- seed: number
  
  initial murmur hash seed as an unsigned 32-bit integer.
- Optional endianness: Endianness
  
  digest byte order: "BE", "LE" or "platform", optional. Default is "BE".
Returns IMurHasher
- Defined in incremental.d.ts:157
Creates MurmurHash utility.

The initial state is taken from the serialized state. Throws an error if serial is incorrect.

Parameters
- serial: string | Buffer
  
  serialized state of the same MurmurHash type.
- Optional endianness: Endianness
  
  digest byte order: "BE", "LE" or "platform", optional. Default is "BE".
Returns IMurHasher
- Defined in incremental.d.ts:166
Creates MurmurHash utility.

The initial state is taken from another instance of murmur hash utility. Throws an error if incompatible hash is provided.

Parameters
- hash: IMurHasher
  
  an instance of another MurmurHash.
- Optional endianness: Endianness
  
  digest byte order: "BE", "LE" or "platform", optional. Default is "BE".
Returns IMurHasher

Properties

SERIAL_BYTE_LENGTH

SERIAL_BYTE_LENGTH: number

Size in bytes of the serialized hasher.

Generated using TypeDoc