fast-fs-hash - v0.0.0-rc4
GitHub
npm
Preparing search index...
IXxHash128Functions
Interface IXxHash128Functions
Stateless xxHash128 digest functions — available as static methods on XxHash128Stream.
interface
IXxHash128Functions
{
digestBuffer
(
input
:
Uint8Array
)
:
Buffer
;
digestBufferRange
(
input
:
Uint8Array
,
offset
:
number
,
length
?:
number
,
)
:
Buffer
;
digestBufferRangeTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
Uint8Array
,
offset
:
number
,
length
:
number
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
;
digestBufferTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
Uint8Array
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
;
digestFile
(
path
:
string
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
;
digestFilesParallel
(
paths
:
readonly
string
[]
,
concurrency
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
;
digestFilesParallelTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
>
(
paths
:
readonly
string
[]
,
out
:
TOut
,
outOffset
?:
number
,
concurrency
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
;
digestFilesSequential
(
paths
:
readonly
string
[]
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
;
digestFilesSequentialTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
>
(
paths
:
readonly
string
[]
,
out
:
TOut
,
outOffset
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
;
digestFileTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
path
:
string
,
out
:
TOut
,
outOffset
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
;
digestString
(
input
:
string
)
:
Buffer
;
digestStringTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
string
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
;
}
Index
Methods
digest
Buffer
digest
Buffer
Range
digest
Buffer
Range
To
digest
Buffer
To
digest
File
digest
Files
Parallel
digest
Files
Parallel
To
digest
Files
Sequential
digest
Files
Sequential
To
digest
File
To
digest
String
digest
String
To
Methods
digest
Buffer
digestBuffer
(
input
:
Uint8Array
)
:
Buffer
Parameters
input
:
Uint8Array
Returns
Buffer
digest
Buffer
Range
digestBufferRange
(
input
:
Uint8Array
,
offset
:
number
,
length
?:
number
)
:
Buffer
Parameters
input
:
Uint8Array
offset
:
number
Optional
length
:
number
Returns
Buffer
digest
Buffer
Range
To
digestBufferRangeTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
Uint8Array
,
offset
:
number
,
length
:
number
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
Parameters
input
:
Uint8Array
offset
:
number
length
:
number
out
:
TOut
Optional
outOffset
:
number
Returns
TOut
digest
Buffer
To
digestBufferTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
Uint8Array
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
Parameters
input
:
Uint8Array
out
:
TOut
Optional
outOffset
:
number
Returns
TOut
digest
File
digestFile
(
path
:
string
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
Parameters
path
:
string
Optional
throwOnError
:
boolean
Returns
Promise
<
Buffer
<
ArrayBufferLike
>
>
digest
Files
Parallel
digestFilesParallel
(
paths
:
readonly
string
[]
,
concurrency
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
Parameters
paths
:
readonly
string
[]
Optional
concurrency
:
number
Optional
throwOnError
:
boolean
Returns
Promise
<
Buffer
<
ArrayBufferLike
>
>
digest
Files
Parallel
To
digestFilesParallelTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
>
(
paths
:
readonly
string
[]
,
out
:
TOut
,
outOffset
?:
number
,
concurrency
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
Parameters
paths
:
readonly
string
[]
out
:
TOut
Optional
outOffset
:
number
Optional
concurrency
:
number
Optional
throwOnError
:
boolean
Returns
Promise
<
TOut
>
digest
Files
Sequential
digestFilesSequential
(
paths
:
readonly
string
[]
,
throwOnError
?:
boolean
,
)
:
Promise
<
Buffer
<
ArrayBufferLike
>
>
Parameters
paths
:
readonly
string
[]
Optional
throwOnError
:
boolean
Returns
Promise
<
Buffer
<
ArrayBufferLike
>
>
digest
Files
Sequential
To
digestFilesSequentialTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
>
(
paths
:
readonly
string
[]
,
out
:
TOut
,
outOffset
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
Parameters
paths
:
readonly
string
[]
out
:
TOut
Optional
outOffset
:
number
Optional
throwOnError
:
boolean
Returns
Promise
<
TOut
>
digest
File
To
digestFileTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
>
(
path
:
string
,
out
:
TOut
,
outOffset
?:
number
,
throwOnError
?:
boolean
,
)
:
Promise
<
TOut
>
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
Parameters
path
:
string
out
:
TOut
Optional
outOffset
:
number
Optional
throwOnError
:
boolean
Returns
Promise
<
TOut
>
digest
String
digestString
(
input
:
string
)
:
Buffer
Parameters
input
:
string
Returns
Buffer
digest
String
To
digestStringTo
<
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
,
>
(
input
:
string
,
out
:
TOut
,
outOffset
?:
number
,
)
:
TOut
Type Parameters
TOut
extends
Uint8Array
<
ArrayBufferLike
>
=
Buffer
<
ArrayBufferLike
>
Parameters
input
:
string
out
:
TOut
Optional
outOffset
:
number
Returns
TOut
Settings
Member Visibility
Protected
Inherited
External
Theme
OS
Light
Dark
On This Page
Methods
digest
Buffer
digest
Buffer
Range
digest
Buffer
Range
To
digest
Buffer
To
digest
File
digest
Files
Parallel
digest
Files
Parallel
To
digest
Files
Sequential
digest
Files
Sequential
To
digest
File
To
digest
String
digest
String
To
GitHub
npm
fast-fs-hash - v0.0.0-rc4
Loading...
Stateless xxHash128 digest functions — available as static methods on XxHash128Stream.