MurmurHash | murmurhash-native

An incremental murmur hash utility with additional node's stream.Transform api

Hierarchy

Transform
- MurmurHash

Implements

ReadableStream
Writable
IMurHasher

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new MurmurHash(algorithm: string | MurmurHash | MurmurHashSerial, options?: MurmurHashOptions): MurmurHash
new MurmurHash(algorithm: string, seed?: number): MurmurHash

Overrides Transform.__constructor
- Defined in stream.d.ts:69
Parameters
- algorithm: string | MurmurHash | MurmurHashSerial
- Optional options: MurmurHashOptions
Returns MurmurHash
Overrides Transform.__constructor
- Defined in stream.d.ts:70
Parameters
- algorithm: string
- Optional seed: number
Returns MurmurHash

Properties

SERIAL_BYTE_LENGTH

SERIAL_BYTE_LENGTH: number

Protected _handle

_handle: IMurHasher

endianness

endianness: Endianness

isBusy

isBusy: boolean

readable

readable: boolean

readableHighWaterMark

readableHighWaterMark: number

readableLength

readableLength: number

total

total: number

writable

writable: boolean

writableHighWaterMark

writableHighWaterMark: number

writableLength

writableLength: number

Static SERIAL_BYTE_LENGTH

SERIAL_BYTE_LENGTH: number

Size in bytes of the serialized hasher.

Static defaultMaxListeners

defaultMaxListeners: number

Methods

__@asyncIterator

__@asyncIterator(): AsyncIterableIterator<any>

Inherited from Readable.[Symbol.asyncIterator]
- Defined in node_modules/@types/node/index.d.ts:6706
Returns AsyncIterableIterator<any>

_destroy

_destroy(error: Error | null, callback: function): void

Inherited from Duplex._destroy

Overrides Readable._destroy
- Defined in node_modules/@types/node/index.d.ts:6824
Parameters
- error: Error | null
- callback: function
  - - (error: Error | null): void
    - Parameters
      - error: Error | null
      Returns void
Returns void

_final

_final(callback: function): void

Inherited from Duplex._final
- Defined in node_modules/@types/node/index.d.ts:6825
Parameters
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

_flush

_flush(callback: TransformCallback): void

Inherited from Transform._flush
- Defined in node_modules/@types/node/index.d.ts:6851
Parameters
- callback: TransformCallback
Returns void

_read

_read(size: number): void

Inherited from Readable._read
- Defined in node_modules/@types/node/index.d.ts:6635
Parameters
- size: number
Returns void

_transform

_transform(chunk: any, encoding: string, callback: TransformCallback): void

Inherited from Transform._transform
- Defined in node_modules/@types/node/index.d.ts:6850
Parameters
- chunk: any
- encoding: string
- callback: TransformCallback
Returns void

_write

_write(chunk: any, encoding: string, callback: function): void

Inherited from Duplex._write
- Defined in node_modules/@types/node/index.d.ts:6822
Parameters
- chunk: any
- encoding: string
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

Optional _writev

_writev(chunks: Array<object>, callback: function): void

Inherited from Duplex._writev
- Defined in node_modules/@types/node/index.d.ts:6823
Parameters
- chunks: Array<object>
- callback: function
  - - (error?: Error | null): void
    - Parameters
      - Optional error: Error | null
      Returns void
Returns void

addListener

addListener(event: "close", listener: function): this
addListener(event: "data", listener: function): this
addListener(event: "end", listener: function): this
addListener(event: "readable", listener: function): this
addListener(event: "error", listener: function): this
addListener(event: string | symbol, listener: function): this

Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6657
Event emitter The defined events on documents including:
1. close
2. data
3. end
4. readable
5. error
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6658
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6659
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6660
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6661
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.addListener

Overrides EventEmitter.addListener
- Defined in node_modules/@types/node/index.d.ts:6662
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

copy

copy(target: MurmurHash): MurmurHash

- Defined in stream.d.ts:72
Parameters
- target: MurmurHash
Returns MurmurHash

cork

cork(): void

Inherited from Duplex.cork
- Defined in node_modules/@types/node/index.d.ts:6832
Returns void

destroy

destroy(error?: Error): void

Inherited from Readable.destroy
- Defined in node_modules/@types/node/index.d.ts:6646
Parameters
- Optional error: Error
Returns void

digest

digest(outputType?: OutputType): number | string | Buffer
digest(output: Buffer, offset?: number, length?: number): Buffer

Implementation of IMurHasher.digest
- Defined in stream.d.ts:73
Parameters
- Optional outputType: OutputType
Returns number | string | Buffer
Implementation of IMurHasher.digest
- Defined in stream.d.ts:74
Parameters
- output: Buffer
- Optional offset: number
- Optional length: number
Returns Buffer

emit

emit(event: "close"): boolean
emit(event: "data", chunk: any): boolean
emit(event: "end"): boolean
emit(event: "readable"): boolean
emit(event: "error", err: Error): boolean
emit(event: string | symbol, ...args: any[]): boolean

Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6664
Parameters
- event: "close"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6665
Parameters
- event: "data"
- chunk: any
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6666
Parameters
- event: "end"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6667
Parameters
- event: "readable"
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6668
Parameters
- event: "error"
- err: Error
Returns boolean
Inherited from Readable.emit

Overrides EventEmitter.emit
- Defined in node_modules/@types/node/index.d.ts:6669
Parameters
- event: string | symbol
- Rest ...args: any[]
Returns boolean

end

end(cb?: function): void
end(chunk: any, cb?: function): void
end(chunk: any, encoding?: string, cb?: function): void

Inherited from Duplex.end
- Defined in node_modules/@types/node/index.d.ts:6829
Parameters
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/index.d.ts:6830
Parameters
- chunk: any
- Optional cb: function
  - - (): void
    - Returns void
Returns void
Inherited from Duplex.end
- Defined in node_modules/@types/node/index.d.ts:6831
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: function
  - - (): void
    - Returns void
Returns void

eventNames

eventNames(): Array<string | symbol>

Inherited from EventEmitter.eventNames

Overrides EventEmitter.eventNames
- Defined in node_modules/@types/node/index.d.ts:1104
Returns Array<string | symbol>

getMaxListeners

getMaxListeners(): number

Inherited from EventEmitter.getMaxListeners

Overrides EventEmitter.getMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1100
Returns number

isPaused

isPaused(): boolean

Inherited from Readable.isPaused
- Defined in node_modules/@types/node/index.d.ts:6640
Returns boolean

listenerCount

listenerCount(type: string | symbol): number

Inherited from EventEmitter.listenerCount

Overrides EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1105
Parameters
- type: string | symbol
Returns number

listeners

listeners(event: string | symbol): Function[]

Inherited from EventEmitter.listeners

Overrides EventEmitter.listeners
- Defined in node_modules/@types/node/index.d.ts:1101
Parameters
- event: string | symbol
Returns Function[]

off

off(event: string | symbol, listener: function): this

Inherited from EventEmitter.off

Overrides EventEmitter.off
- Defined in node_modules/@types/node/index.d.ts:1097
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

on

on(event: "close", listener: function): this
on(event: "data", listener: function): this
on(event: "end", listener: function): this
on(event: "readable", listener: function): this
on(event: "error", listener: function): this
on(event: string | symbol, listener: function): this

Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6671
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6672
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6673
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6674
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6675
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.on

Overrides EventEmitter.on
- Defined in node_modules/@types/node/index.d.ts:6676
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

once

once(event: "close", listener: function): this
once(event: "data", listener: function): this
once(event: "end", listener: function): this
once(event: "readable", listener: function): this
once(event: "error", listener: function): this
once(event: string | symbol, listener: function): this

Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6678
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6679
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6680
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6681
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6682
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.once

Overrides EventEmitter.once
- Defined in node_modules/@types/node/index.d.ts:6683
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

pause

pause(): this

Inherited from Readable.pause
- Defined in node_modules/@types/node/index.d.ts:6638
Returns this

pipe

pipe<T>(destination: T, options?: object): T

Inherited from internal.pipe
- Defined in node_modules/@types/node/index.d.ts:6616
Type parameters
- T: WritableStream
Parameters
- destination: T
- Optional options: object
  - Optional end?: boolean
Returns T

prependListener

prependListener(event: "close", listener: function): this
prependListener(event: "data", listener: function): this
prependListener(event: "end", listener: function): this
prependListener(event: "readable", listener: function): this
prependListener(event: "error", listener: function): this
prependListener(event: string | symbol, listener: function): this

Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6685
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6686
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6687
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6688
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6689
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependListener

Overrides EventEmitter.prependListener
- Defined in node_modules/@types/node/index.d.ts:6690
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

prependOnceListener

prependOnceListener(event: "close", listener: function): this
prependOnceListener(event: "data", listener: function): this
prependOnceListener(event: "end", listener: function): this
prependOnceListener(event: "readable", listener: function): this
prependOnceListener(event: "error", listener: function): this
prependOnceListener(event: string | symbol, listener: function): this

Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6692
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6693
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6694
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6695
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6696
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.prependOnceListener

Overrides EventEmitter.prependOnceListener
- Defined in node_modules/@types/node/index.d.ts:6697
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

push

push(chunk: any, encoding?: string): boolean

Inherited from Readable.push
- Defined in node_modules/@types/node/index.d.ts:6644
Parameters
- chunk: any
- Optional encoding: string
Returns boolean

rawListeners

rawListeners(event: string | symbol): Function[]

Inherited from EventEmitter.rawListeners

Overrides EventEmitter.rawListeners
- Defined in node_modules/@types/node/index.d.ts:1102
Parameters
- event: string | symbol
Returns Function[]

read

read(size?: number): any

Inherited from Readable.read
- Defined in node_modules/@types/node/index.d.ts:6636
Parameters
- Optional size: number
Returns any

removeAllListeners

removeAllListeners(event?: string | symbol): this

Inherited from EventEmitter.removeAllListeners

Overrides EventEmitter.removeAllListeners
- Defined in node_modules/@types/node/index.d.ts:1098
Parameters
- Optional event: string | symbol
Returns this

removeListener

removeListener(event: "close", listener: function): this
removeListener(event: "data", listener: function): this
removeListener(event: "end", listener: function): this
removeListener(event: "readable", listener: function): this
removeListener(event: "error", listener: function): this
removeListener(event: string | symbol, listener: function): this

Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6699
Parameters
- event: "close"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6700
Parameters
- event: "data"
- listener: function
  - - (chunk: any): void
    - Parameters
      - chunk: any
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6701
Parameters
- event: "end"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6702
Parameters
- event: "readable"
- listener: function
  - - (): void
    - Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6703
Parameters
- event: "error"
- listener: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns this
Inherited from Readable.removeListener

Overrides EventEmitter.removeListener
- Defined in node_modules/@types/node/index.d.ts:6704
Parameters
- event: string | symbol
- listener: function
  - - (...args: any[]): void
    - Parameters
      - Rest ...args: any[]
      Returns void
Returns this

resume

resume(): this

Inherited from Readable.resume
- Defined in node_modules/@types/node/index.d.ts:6639
Returns this

serialize

serialize(): string
serialize(output: Buffer, offset?: number): Buffer

Implementation of IMurHasher.serialize
- Defined in stream.d.ts:76
Returns string
Implementation of IMurHasher.serialize
- Defined in stream.d.ts:77
Parameters
- output: Buffer
- Optional offset: number
Returns Buffer

setDefaultEncoding

setDefaultEncoding(encoding: string): this

Inherited from Duplex.setDefaultEncoding
- Defined in node_modules/@types/node/index.d.ts:6828
Parameters
- encoding: string
Returns this

setEncoding

setEncoding(encoding: string): this

Inherited from Readable.setEncoding
- Defined in node_modules/@types/node/index.d.ts:6637
Parameters
- encoding: string
Returns this

setMaxListeners

setMaxListeners(n: number): this

Inherited from EventEmitter.setMaxListeners

Overrides EventEmitter.setMaxListeners
- Defined in node_modules/@types/node/index.d.ts:1099
Parameters
- n: number
Returns this

toJSON

toJSON(): MurmurHashSerial

Implementation of IMurHasher.toJSON
- Defined in stream.d.ts:75
Returns MurmurHashSerial

uncork

uncork(): void

Inherited from Duplex.uncork
- Defined in node_modules/@types/node/index.d.ts:6833
Returns void

unpipe

unpipe(destination?: WritableStream): this

Inherited from Readable.unpipe
- Defined in node_modules/@types/node/index.d.ts:6641
Parameters
- Optional destination: WritableStream
Returns this

unshift

unshift(chunk: any): void

Inherited from Readable.unshift
- Defined in node_modules/@types/node/index.d.ts:6642
Parameters
- chunk: any
Returns void

update

update(data: string | Buffer, encoding?: Encoding): this
update(data: string | Buffer, encoding: Encoding, callback: function): void
update(data: string | Buffer, callback: function): void

Implementation of IMurHasher.update
- Defined in stream.d.ts:78
Parameters
- data: string | Buffer
- Optional encoding: Encoding
Returns this
- Defined in stream.d.ts:79
Parameters
- data: string | Buffer
- encoding: Encoding
- callback: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void
- Defined in stream.d.ts:80
Parameters
- data: string | Buffer
- callback: function
  - - (err: Error): void
    - Parameters
      - err: Error
      Returns void
Returns void

wrap

wrap(oldStream: ReadableStream): this

Inherited from Readable.wrap
- Defined in node_modules/@types/node/index.d.ts:6643
Parameters
- oldStream: ReadableStream
Returns this

write

write(chunk: any, cb?: function): boolean
write(chunk: any, encoding?: string, cb?: function): boolean

Inherited from Duplex.write
- Defined in node_modules/@types/node/index.d.ts:6826
Parameters
- chunk: any
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean
Inherited from Duplex.write
- Defined in node_modules/@types/node/index.d.ts:6827
Parameters
- chunk: any
- Optional encoding: string
- Optional cb: function
  - - (error: Error | null | undefined): void
    - Parameters
      - error: Error | null | undefined
      Returns void
Returns boolean

Static listenerCount

listenerCount(emitter: EventEmitter, event: string | symbol): number

Inherited from EventEmitter.listenerCount
- Defined in node_modules/@types/node/index.d.ts:1088
deprecated

since v4.0.0

Parameters
- emitter: EventEmitter
- event: string | symbol
Returns number

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

algorithm: string | MurmurHash | MurmurHashSerial

Optional options: MurmurHashOptions

Returns MurmurHash

Parameters

algorithm: string

Optional seed: number

Returns MurmurHash

Properties

SERIAL_BYTE_LENGTH

Protected _handle

endianness

isBusy

readable

readableHighWaterMark

readableLength

total

writable

writableHighWaterMark

writableLength

Static SERIAL_BYTE_LENGTH

Static defaultMaxListeners

Methods

__@asyncIterator

Returns AsyncIterableIterator<any>

_destroy

Parameters

error: Error | null

callback: function

Parameters

error: Error | null

Returns void

Returns void

_final

Parameters

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

_flush

Parameters

callback: TransformCallback

Returns void

_read

Parameters

size: number

Returns void

_transform

Parameters

chunk: any

encoding: string

callback: TransformCallback

Returns void

_write

Parameters

chunk: any

encoding: string

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

Optional _writev

Parameters

chunks: Array<object>

callback: function

Parameters

Optional error: Error | null

Returns void

Returns void

addListener